Skip to content

docs: add documentation style guide for community and AI-assisted contributions#2054

Open
kenvandine wants to merge 6 commits into
lemonade-sdk:mainfrom
kenvandine:docs/documentation-style-guide
Open

docs: add documentation style guide for community and AI-assisted contributions#2054
kenvandine wants to merge 6 commits into
lemonade-sdk:mainfrom
kenvandine:docs/documentation-style-guide

Conversation

@kenvandine
Copy link
Copy Markdown
Member

Summary

  • Adds 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.
  • Adds a specific section on AI-assisted contributions: a failure-mode table
    and a pre-submission checklist so AI-drafted docs meet the same accuracy bar
    as hand-written ones.
  • Small edits to docs/dev/README.md and docs/dev/contribute.md to link the
    new 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

  • All internal links in docs/dev/documentation.md resolve correctly.
  • Links from README.md and contribute.md to the new guide are correct.
  • Style and tone are consistent with existing guide docs.
  • No build artifacts or code changes included.

…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
@kenvandine kenvandine requested a review from jeremyfowers May 31, 2026 23:47
Copy link
Copy Markdown
Collaborator

@fl0rianr fl0rianr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/dev/documentation.md
Comment thread docs/dev/documentation.md
Comment thread docs/dev/documentation.md
Comment thread docs/dev/documentation.md
Comment thread docs/dev/documentation.md
@jeremyfowers
Copy link
Copy Markdown
Member

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.

Comment thread docs/dev/documentation.md
Comment thread docs/dev/documentation.md
Comment thread docs/dev/documentation.md Outdated
Comment thread docs/dev/documentation.md Outdated
Comment thread docs/dev/documentation.md Outdated
Comment thread docs/dev/documentation.md Outdated
Comment thread docs/dev/documentation.md Outdated
Comment thread docs/dev/documentation.md Outdated
Comment thread docs/dev/documentation.md Outdated
Comment thread docs/dev/documentation.md Outdated
Comment thread docs/dev/documentation.md
Comment thread docs/dev/documentation.md Outdated
Comment thread docs/dev/documentation.md Outdated
Comment thread docs/dev/documentation.md Outdated
Comment thread docs/dev/documentation.md Outdated
Comment thread docs/dev/documentation.md Outdated
Comment thread docs/dev/documentation.md Outdated
Comment thread docs/dev/documentation.md
Copy link
Copy Markdown
Member

@jeremyfowers jeremyfowers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
@kenvandine
Copy link
Copy Markdown
Member Author

All review feedback addressed in the latest commit (346a199):

fl0rianr:

  • Added sidebar nav entry to mkdocs.yml
  • Added table of contents (doc's own 5+ H2 rule applies here)
  • Fixed both nested fenced code block examples to use 4-backtick outer fences
  • Added Lossy rewriting and Slop-style writing rows to the AI failure-mode table
  • Added preservation-during-rewrites checklist item

jeremyfowers:

  • Renamed ### Automate the documentation away### Simplify instead of documenting
  • Changed ### The reader is a capable adult### The reader is capable
  • Clarified pronoun rule for developer-docs context (when "the user" is the developer's end-user)
  • Updated Voice/Tone table: stricter humor rule, added Figures of speech and Marketing language rows
  • Revised tab/variant rule to prefer tabs even for small per-platform differences (copy-pastable snippets)
  • Softened the two-item table rule to allow judgment
  • Made inline formatting examples consistently escaped
  • Expanded CLI-commands checklist item to cover curl commands and test scripts
  • Replaced overly-specific sentence-opener item with a broader style/slop-patterns item
  • Broadened code-examples item to cover all executable content
  • Replaced vague length item with a specific cut-criteria rule
  • Consolidated Community Contribution Process: removed redundant ### Before you start sub-heading, merged Review expectations + Maintainer for documentation into a single ### Review and ownership section
  • Updated maintainer to @jeremyfowers per suggested text

@kenvandine kenvandine requested a review from jeremyfowers June 1, 2026 14:34
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@fl0rianr
Copy link
Copy Markdown
Collaborator

fl0rianr commented Jun 1, 2026

Thanks @kenvandine! This is very close. If I got it right wo small items Jeremy mentioned still look unresolved to me before I approve:

  1. The checklist still says “All links resolve to real pages.” I’d prefer the more specific wording:
    “All internal links, anchors, external links, and referenced files resolve correctly.”

  2. The Quick Reference still says “Using a table for 2 items”, which seems to contradict the updated Tables section. Maybe:
    “Using a table when a sentence or list would be clearer | Use a sentence or list instead”

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>
@kenvandine
Copy link
Copy Markdown
Member Author

Both addressed in 3726df6:

  1. Checklist item updated to "All internal links, anchors, external links, and referenced files resolve correctly."
  2. Quick Reference row updated to "Using a table when a list or sentence would be clearer | Use a sentence or list instead"

Copy link
Copy Markdown
Collaborator

@fl0rianr fl0rianr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! You have my go, but I think you should have @jeremyfowers give the opportunity as well.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants