mirror of
https://github.com/MoonshotAI/kimi-code.git
synced 2026-07-10 01:39:25 +00:00
0e1665173d
* docs: expand AGENTS.md with reader personas, format decisions, and checklist Add documentation writing principles that were missing from the existing guide: - Readers: two audience types (technical vs non-technical) with writing targets - Authoring workflow: think before rewriting (understand → structure → fill) - Kimi platform rules: strict separation of api.kimi.com vs api.moonshot.cn URLs - Typography: forbid four-colon callout syntax (::::), note no nesting - Writing style: one-idea-per-paragraph, map-before-detail structure, clarify when to use lists vs prose (avoids confusion between 'no fragmentation' and 'parallel content needs formatting') - Format decisions: explicit rules for ordered list / unordered list / table / prose - Cross-references: when links are required, anchor precision, inline vs next-steps - Page structure: standard template and banner placement rule - Content completeness: default to keeping everything, omissions need stated reasons - Checklist: format violation quick-reference and Kimi-specific consistency checks All existing rules are preserved unchanged (0 lines removed). * docs: address review comments on AGENTS.md - Fix "next steps" rule contradiction: replace blanket ban with "no nav tip blocks"; `## Next steps` is allowed when related pages exist - Fix checklist Base URL pointer: was pointing to locale index.md (which has no platform table); now links to Kimi platform rules above - Fix callout syntax rule: `::::` is valid as an outer nested fence when correctly closed; ban only unclosed/mismatched fences - Fix checklist code block rule: carry forward the existing exception that natural-language prompt examples may omit the language tag --------- Co-authored-by: qer <wbxl2000@outlook.com> |
||
|---|---|---|
| .. | ||
| .vitepress | ||
| en | ||
| media | ||
| public | ||
| zh | ||
| .gitignore | ||
| AGENTS.md | ||
| index.md | ||
| package.json | ||