docs: add comprehensive Korean documentation in .docs folder #997
Conversation
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
- Create structured documentation covering entire codebase - Add 7 markdown files with detailed explanations: - README.md: Documentation index and quick start - 01-project-overview.md: Project purpose and features - 02-technology-stack.md: Technologies and dependencies - 03-directory-structure.md: Project structure (13KB) - 04-architecture.md: System architecture and design patterns - 05-key-components.md: Component details (CLI, Core, VS Code) - 06-development-guide.md: Development setup and workflows - Documentation is in Korean for better accessibility - Includes architecture diagrams, code examples, and best practices - Total ~70KB of comprehensive technical documentation
- Create detailed prompt documentation covering entire prompt system - Add 6 markdown files with in-depth analysis: - README.md: Prompt system overview and architecture - 01-core-system-prompts.md: Main agent system prompts - 02-subagent-prompts.md: Subagent system and generator - 03-tool-prompts.md: Tool description prompts - 04-specialized-prompts.md: LLM Edit Fixer, Loop Detection, etc - 05-prompt-template-system.md: Template engine and dynamic generation - Document all prompt types: - System prompts (core agent behavior) - Subagent prompts (specialized agents) - Tool prompts (function calling) - Specialized prompts (edit fixing, loop detection, summarization) - Include detailed analysis of: - Prompt loading mechanisms (environment variables, file paths) - Template variable substitution - Dynamic prompt generation - Model-specific optimizations - Caching strategies - Provide code examples and usage patterns - Total ~30KB of comprehensive prompt documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Create structured documentation covering entire codebase
Add 7 markdown files with detailed explanations:
Documentation is in Korean for better accessibility
Includes architecture diagrams, code examples, and best practices
Total ~70KB of comprehensive technical documentation
TLDR
Dive Deeper
Reviewer Test Plan
Testing Matrix
Linked issues / bugs