docs: add documentation style guide for community and AI-assisted contributions#2054
docs: add documentation style guide for community and AI-assisted contributions#2054kenvandine wants to merge 6 commits into
Conversation
…tributions Introduces docs/dev/documentation.md covering writing principles, voice and tone, document structure by type, formatting conventions (code blocks, tables, callouts, status badges), file/directory layout, and a pre-submission checklist for AI-drafted content. Links the guide from the dev README and contribute.md. https://claude.ai/code/session_01VgSM6CxyttJe3JyWytctGm
fl0rianr
left a comment
There was a problem hiding this comment.
Very Nice! One small site-navigation note: should dev/documentation.md also be added to mkdocs.yml under Development? Right now the new page is linked from docs/dev/README.md, but it does not appear in the sidebar nav.
Yes all new docs, including this one, should be added to mkdocs.yml nav. |
jeremyfowers
left a comment
There was a problem hiding this comment.
This will be a very nice document to have! Please see review feedback.
- Add mkdocs.yml nav entry so the guide appears in the sidebar - Add table of contents (doc has 8 H2s, per its own ToC rule) - Rename ambiguous heading "Automate the documentation away" - Broaden "capable adult" → "capable" (inclusive of students) - Expand pronoun guidance for developer-docs context - Update Voice/Tone table: stricter humor rule, add figures-of-speech and marketing-language rows - Fix nested fenced code blocks in multi-platform and CLI templates - Revise tab/variant rule: prefer tabs even for small differences - Soften two-item table rule to allow judgment - Escape inline formatting examples consistently - Add Lossy rewriting and Slop-style writing AI failure-mode rows - Strengthen pre-submission checklist: broader executable-content coverage, preservation-during-rewrites item, cleaner length rule - Consolidate Community Contribution Process: remove redundant sub-sections, merge Review/Maintainer into single section, update maintainer to @jeremyfowers Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
All review feedback addressed in the latest commit (346a199): fl0rianr:
jeremyfowers:
|
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Thanks @kenvandine! This is very close. If I got it right wo small items Jeremy mentioned still look unresolved to me before I approve:
After that this looks good to me. |
- Expand links checklist item to cover anchors, external links, and referenced files explicitly - Update Quick Reference table row to match the softened Tables rule (judgment-based rather than a hard 2-item threshold) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Both addressed in 3726df6:
|
fl0rianr
left a comment
There was a problem hiding this comment.
Thanks! You have my go, but I think you should have @jeremyfowers give the opportunity as well.
Summary
docs/dev/documentation.md— a style guide covering writing principles,voice and tone, document structure by type (concept, how-to, API reference,
integration guide), formatting conventions (code blocks, tables, callouts,
status badges, collapsible sections), file/directory layout, and templates
contributors can copy directly.
and a pre-submission checklist so AI-drafted docs meet the same accuracy bar
as hand-written ones.
docs/dev/README.mdanddocs/dev/contribute.mdto link thenew guide from the developer hub and the existing AI Policy section.
Why
Documentation guidance was previously distributed across AGENTS.md,
contribute.md, and philosophy.md without a single place that answered "how
should I write a doc?" The guide pulls these threads together and adds concrete
formatting conventions derived from the existing ~58 doc files.
Test plan
docs/dev/documentation.mdresolve correctly.README.mdandcontribute.mdto the new guide are correct.