docs: rewrite README to ergonomic structure and add documentation pages#379
Merged
Conversation
Migrate the Usage, JSON Output Format, and Usage Examples sections from README.md / README.ja.md into a dedicated CLI reference doc, following the existing documentation/ en/ja pairing convention. Adds a table of contents and places each command's JSON example once, under its own section.
Migrate the Configuration chapter from README.md/README.ja.md into dedicated documentation files, and fix the Board Settings default port from 3000 to 8080 to match DEFAULT_BOARD_PORT in src/cli/utils/constants.ts.
Restructure both READMEs into Hero/Features/Quick Start/Command Reference/Claude Code Integration/Configuration/Task Statuses/ Documentation/License, cutting ~1150 lines down to ~190 by moving detailed CLI and configuration reference content into documentation/cli-reference.md and documentation/configuration.md. Move the Technology Stack section into documentation/development.md and documentation/development.ja.md, and drop the Planned Features chapter, which referenced a nonexistent doc and an unimplemented command.
Update project description in both English and Japanese to emphasize the integrated CLI & Kanban board capabilities. Remove outdated metadata feature mention that no longer reflects the current feature set. - README.md: Update tagline and feature list - README.ja.md: Sync Japanese translation with updated content Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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
Test plan