Conversation
Add documentation index page (#2) # Summary Closes #<issue number> - [] I have read the [Contributing](../CONTRIBUTING.md) and the strict [No-AI Policy](../AI_POLICY.md) guides. ## How Did You Test this Change? ## Images/Videos <!-- if relevant, please include any relevant images that show off how your feature is working --> <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/clauderiks/ide/pull/2" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1"> <img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open in Devin Review"> </picture> </a> <!-- devin-review-badge-end -->
### Motivation - Improve first-impression documentation by making the README more concise and visually focused with a centered hero and larger badges. - Prioritize Vietnamese-first copy and a simpler structure so readers can find installation, preview, and configuration info quickly. - Remove and condense overly broad or duplicate documentation sections to keep the repository README focused on the gh-dash terminal dashboard experience. ### Description - Updated `README.md` to a redesigned layout with a centered hero, prominent badge styling, and Vietnamese-first description. - Reorganized content into concise sections: highlights, table of contents, quick install, UI preview, default keybindings, sample config, developer setup, troubleshooting, and contribution guidance. - Simplified and translated configuration and customization tables to compact, developer-oriented examples and removed extraneous API/examples material. - Kept sample commands and `~/.config/gh-dash/config.yml` snippets intact and reformatted code blocks for readability. ### Testing - Ran `npm run lint` (TypeScript type check via `tsc --noEmit`) which produced type errors originating from existing `docs/node_modules` and application type definitions, so linting did not pass and is unrelated to this README-only change. - No other automated tests were run as part of this PR since the change is documentation-only. ------ [Codex Task](https://chatgpt.com/codex/cloud/tasks/task_e_6a69d15d1bf4832daa7391fd865aa383) <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/clauderiks/ide/pull/3" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1"> <img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open in Devin Review"> </picture> </a> <!-- devin-review-badge-end -->
Signed-off-by: Clriks <241179063+clauderiks@users.noreply.github.com>
Add documentation index page (#2) # Summary Closes #<issue number> - [] I have read the [Contributing](../CONTRIBUTING.md) and the strict [No-AI Policy](../AI_POLICY.md) guides. ## How Did You Test this Change? ## Images/Videos <!-- if relevant, please include any relevant images that show off how your feature is working --> <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/clauderiks/ide/pull/2" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1"> <img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open in Devin Review"> </picture> </a> <!-- devin-review-badge-end --> (#4) # Summary Closes #<issue number> - [] I have read the [Contributing](../CONTRIBUTING.md) and the strict [No-AI Policy](../AI_POLICY.md) guides. ## How Did You Test this Change? ## Images/Videos <!-- if relevant, please include any relevant images that show off how your feature is working --> <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/clauderiks/ide/pull/4" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1"> <img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open in Devin Review"> </picture> </a> <!-- devin-review-badge-end -->
# Summary Closes #<issue number> - [] I have read the [Contributing](../CONTRIBUTING.md) and the strict [No-AI Policy](../AI_POLICY.md) guides. ## How Did You Test this Change? ## Images/Videos <!-- if relevant, please include any relevant images that show off how your feature is working --> <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/clauderiks/ide/pull/5" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1"> <img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open in Devin Review"> </picture> </a> <!-- devin-review-badge-end -->
# Summary Closes #<issue number> - [] I have read the [Contributing](../CONTRIBUTING.md) and the strict [No-AI Policy](../AI_POLICY.md) guides. ## How Did You Test this Change? ## Images/Videos <!-- if relevant, please include any relevant images that show off how your feature is working -->
Merge pull request #1 from clauderiks/project-documentation Add documentation index page (#2) # Summary Closes #<issue number> - [] I have read the [Contributing](../CONTRIBUTING.md) and the strict [No-AI Policy](../AI_POLICY.md) guides. ## How Did You Test this Change? ## Images/Videos <!-- if relevant, please include any relevant images that show off how your feature is working --> <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/clauderiks/ide/pull/2" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1"> <img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open in Devin Review"> </picture> </a> <!-- devin-review-badge-end --> (#4) # Summary Closes #<issue number> - [] I have read the [Contributing](../CONTRIBUTING.md) and the strict [No-AI Policy](../AI_POLICY.md) guides. ## How Did You Test this Change? ## Images/Videos <!-- if relevant, please include any relevant images that show off how your feature is working --> <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/clauderiks/ide/pull/4" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1"> <img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open in Devin Review"> </picture> </a> <!-- devin-review-badge-end -->
# Summary Closes #<issue number> - [] I have read the [Contributing](../CONTRIBUTING.md) and the strict [No-AI Policy](../AI_POLICY.md) guides. ## How Did You Test this Change? ## Images/Videos <!-- if relevant, please include any relevant images that show off how your feature is working --> <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/clauderiks/ide/pull/5" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1"> <img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open in Devin Review"> </picture> </a> <!-- devin-review-badge-end --> (#9) # Summary Closes #<issue number> - [] I have read the [Contributing](../CONTRIBUTING.md) and the strict [No-AI Policy](../AI_POLICY.md) guides. ## How Did You Test this Change? ## Images/Videos <!-- if relevant, please include any relevant images that show off how your feature is working --> <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/clauderiks/ide/pull/9" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1"> <img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open in Devin Review"> </picture> </a> <!-- devin-review-badge-end -->
…11) # Summary Closes #<issue number> - [] I have read the [Contributing](../CONTRIBUTING.md) and the strict [No-AI Policy](../AI_POLICY.md) guides. ## How Did You Test this Change? ## Images/Videos <!-- if relevant, please include any relevant images that show off how your feature is working --> <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/clauderiks/ide/pull/11" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1"> <img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open in Devin Review"> </picture> </a> <!-- devin-review-badge-end -->
# Summary Closes #<issue number> - [] I have read the [Contributing](../CONTRIBUTING.md) and the strict [No-AI Policy](../AI_POLICY.md) guides. ## How Did You Test this Change? ## Images/Videos <!-- if relevant, please include any relevant images that show off how your feature is working --> <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/clauderiks/ide/pull/12" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1"> <img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open in Devin Review"> </picture> </a> <!-- devin-review-badge-end -->
…11) # Summary Closes #<issue number> - [] I have read the [Contributing](../CONTRIBUTING.md) and the strict [No-AI Policy](../AI_POLICY.md) guides. ## How Did You Test this Change? ## Images/Videos <!-- if relevant, please include any relevant images that show off how your feature is working --> <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/clauderiks/ide/pull/11" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1"> <img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open in Devin Review"> </picture> </a> <!-- devin-review-badge-end --> (#16) # Summary Closes #<issue number> - [] I have read the [Contributing](../CONTRIBUTING.md) and the strict [No-AI Policy](../AI_POLICY.md) guides. ## How Did You Test this Change? ## Images/Videos <!-- if relevant, please include any relevant images that show off how your feature is working --> <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/clauderiks/ide/pull/16" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1"> <img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open in Devin Review"> </picture> </a> <!-- devin-review-badge-end -->
# Summary Closes #<issue number> - [] I have read the [Contributing](../CONTRIBUTING.md) and the strict [No-AI Policy](../AI_POLICY.md) guides. ## How Did You Test this Change? ## Images/Videos <!-- if relevant, please include any relevant images that show off how your feature is working -->
Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com> Signed-off-by: clauderiks <241179063+clauderiks@users.noreply.github.com>
|
Kilo Code Review could not run — your account is out of credits. Add credits or switch to a free model to enable reviews on this change. |
PR Summary by QodoRedesign README and add IBM-terminal landing page + bundled docs
AI Description
Diagram
High-Level Assessment
Files changed (6)
|
Code Review by Qodo
1. React entrypoint removed
|
…giao-dien-file-readme.md
Co-authored-by: kilo-code-bot[bot] <240665456+kilo-code-bot[bot]@users.noreply.github.com> Signed-off-by: zskbot <241179063+zskbot@users.noreply.github.com>
Co-authored-by: kilo-code-bot[bot] <240665456+kilo-code-bot[bot]@users.noreply.github.com> Signed-off-by: zskbot <241179063+zskbot@users.noreply.github.com>
Co-authored-by: kilo-code-bot[bot] <240665456+kilo-code-bot[bot]@users.noreply.github.com> Signed-off-by: zskbot <241179063+zskbot@users.noreply.github.com>
Co-authored-by: kilo-code-bot[bot] <240665456+kilo-code-bot[bot]@users.noreply.github.com> Signed-off-by: zskbot <241179063+zskbot@users.noreply.github.com>
Code Review SummaryStatus: No Issues Found | Recommendation: Merge Files Reviewed (6 files)
|
Summary
Closes #
How Did You Test this Change?
Images/Videos