MoonshotAI / MoonshotAI/kimi-code
Documentation restructure to Diátaxis quadrants
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 7.5k
- Forks
- 1.2k
- Avg merge
- 11h 53m
- Merged PRs (30d)
- 350
Description
Question
Restructure documentation to follow the Diátaxis framework with four quadrants:
| Kind | Serves | Answers | Directory |
|---|---|---|---|
| Tutorial | Study through action | "Take me through my first one." | docs/tutorials/ |
| How-to guide | Work through action | "How do I do X?" | docs/how-to/ |
| Reference | Work through cognition | "What exactly does X do?" | docs/reference/ |
| Explanation | Study through cognition | "Why is it built this way?" | docs/explanation/ |
Plus two top-level docs:
docs/README.md— the map. Every document listed once, with a one-line description.docs/compendium.md— the consolidated knowledge base.
Superseded documents move to docs/archive/ unchanged.
Decision needed: Current docs/ has various files. Need to audit and categorize each into the four quadrants. Also need to create the entry-point docs/README.md and docs/compendium.md.
Label: wayfinder:task
Part of #2517
Blocks: #2518
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by auditing the existing files under docs/ and categorize each into docs/tutorials/, docs/how-to/, docs/reference/, docs/explanation/, or docs/archive/. Create docs/README.md as a one-line-per-document map and docs/compendium.md as the consolidated knowledge base. Done means every current document is categorized, superseded documents are moved unchanged, and the two top-level documents are complete.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100