docs: refresh documentation for v0.3.0 release#6
Merged
Conversation
The v0.3.0 release (CLI + tracked changes) shipped, but the hand-written prose docs still self-identified as v0.2.0 and omitted both new surfaces. This re-stamps the narrative docs and fills the v0.3 coverage gaps; the auto-generated reference pages and ROADMAP/CHANGELOG were already current. - README: status block -> v0.3.0; capabilities header through v0.3; "what's next" reframed past-tense; restyle --json clarified; v0.3.0 build-history entry. - docs/index.md: status -> v0.3.0; tracked-changes + CLI capability bullets; roadmap rows marked shipped. - docs/API.md: __version__ -> 0.3.0; "Public surface at v0.3"; add track_changes.py example; new docx_plus.revisions and docx_plus.cli sections. - docs/ARCHITECTURE.md: re-baseline to end-of-v0.3; cli/ and revisions/ in the module tree; new §7.11 (tracked changes) and §7.12 (CLI); §8 invariant 1 notes the cli/ cross-import exception; §10 test count 631 -> 803 (v0.3.0); §11 marks v0.3 targets as shipped. - docs/SKILLS.md: current release -> v0.3.0; cli.md + revisions.md rows. - docs/reference/styles-modify.md: add InvalidColorError to members. - docs/reference/core-errors.md: new page for base DocxPlusError + nav. - skills/.../cli.md: note inspect index is 1-based (vs 0-based paragraph_index); add on/off checkbox tokens. - CLAUDE.md: new repo guidance file for AI agents (commands, layering, conventions, gotchas, release flow). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
Documentation audit for the v0.3.0 release. The auto-generated reference pages,
ROADMAP.md, andCHANGELOG.mdwere already current, but the hand-written prose docs still self-identified as v0.2.0 and omitted the two headline v0.3 surfaces — thedocx-plusCLI and the tracked-changesrevisions/module. This PR re-stamps the narrative docs and fills the coverage gaps.No correctness defects were found in existing content (every code example, signature, and CLI command already matched source); this is a version-currency + v0.3-visibility pass.
Changes
restyle --jsonclarified; v0.3.0 build-history entry.__version__->0.3.0; "Public surface at v0.3";track_changes.pyexample; newdocx_plus.revisions(15 symbols) anddocx_plus.clisections.cli/+revisions/in the module tree; new §7.11 (tracked changes) and §7.12 (CLI); §8 invariant 1 notes thecli/cross-import exception; §10 test count 631 -> 803 (verified viapytest --collect-only); §11 marks v0.3 targets shipped.cli.md+revisions.mdreference rows.InvalidColorErrorto members.DocxPlusError+ nav entry.inspectindex is 1-based (vs 0-basedparagraph_index); addon/offcheckbox tokens.Verification
mkdocs build --strictpasses (caught and fixed one out-of-tree../ROADMAP.mdlink).docx_plus/source.🤖 Generated with Claude Code