Skip to content

docs: add documentation style guidance#133

Merged
rlippmann merged 2 commits into
mainfrom
codex/doc-guidance
May 21, 2026
Merged

docs: add documentation style guidance#133
rlippmann merged 2 commits into
mainfrom
codex/doc-guidance

Conversation

@rlippmann
Copy link
Copy Markdown
Owner

What changed

  • Added a Documentation style section to AGENTS.md.
  • Added a matching Documentation Style section to CONTRIBUTING.md.
  • Guidance is scoped to docs wording only (behavior-first explanations, plain concrete terms, and explicit boundaries for spec/contract docs and fixture/eval-sensitive text).

Why

  • Keep future documentation updates consistent with the newer behavior-first style.
  • Make contributor expectations explicit so readability improvements do not weaken formal guarantees.

Checklist

  • pre-commit run (uv run pre-commit run --all-files)
  • tests pass (uv run pytest)

@rlippmann rlippmann merged commit 9ea3855 into main May 21, 2026
12 checks passed
@rlippmann rlippmann deleted the codex/doc-guidance branch May 21, 2026 05:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant