docs: rewrite README in English with documentation links#5
Merged
Hidden character warning
The head ref may contain hidden characters: "3-readme-\ub97c-\uc601\uc5b4\ub85c-\uc791\uc131"
Conversation
- Transform Korean README to concise English version - Reduce from 360 lines to 124 lines for better readability - Add links to comprehensive documentation site (https://asana.pleaseai.dev/) - Keep quick start examples for immediate value - Maintain all badges, tech stack, and license information - Follow best practice of brief README + detailed docs Closes #3
Closed
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
- Add Homebrew and install script installation methods to getting-started.md - Add self-update and upgrade instructions to getting-started.md - Add dotenvx encryption section to configuration.md - Ensure all content from README is available in comprehensive docs This ensures users can find all installation methods, update procedures, and advanced configuration options in the documentation site.
- Create README.ko.md with Korean content - Add language selector to both README files (English/한국어) - Link to Korean documentation site (https://asana.pleaseai.dev/ko) - Maintain consistent structure between English and Korean versions This provides a better experience for Korean-speaking users by offering documentation in their native language.
This was referenced Oct 25, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrites the README.md in English and transforms it into a concise overview that links to the comprehensive documentation site.
Changes
Benefits
Documentation Structure
The detailed content is now available at:
Closes #3