docs: Documentation Sync rules + CHANGELOG scaffold (#47) - #48
Merged
Conversation
Mirrors the pattern from jayrav13/ruby-pure-greeks. Establishes which doc surface owns which kind of change so docs don't drift silently as the project evolves. Closes #47 Co-Authored-By: Claude <noreply@anthropic.com>
15 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a "Documentation Sync" section to
CLAUDE.md(modeled onruby-pure-greeks)
plus a small "Docs site" section pointing at the live URL and the sibling-Pages
registry.
Scaffolds
CHANGELOG.md(Keep-a-Changelog format) so the docs-sync rules areactionable from day one — the table references it. The
[Unreleased]sectionis pre-populated with what shipped in #46 so the changelog isn't empty on day
one.
This is a slice of Plan B from the umbrella shipping push (#45). The rest of
Plan B (PyPI release, README rewrite, version-bump CI enforcement, 1.0.0
release) follows separately.
Closes #47.
Test plan
make docs-strictpasses (no broken links from new content)Co-authored by Claude