chore(docs): phase 3 - automate reference docs and version injection#29
Merged
chore(docs): phase 3 - automate reference docs and version injection#29
Conversation
- Add MkDocs hook for version variable substitution (hooks/version_vars.py)
- Define capiscio_version and protocol_version in mkdocs.yml extra
- Replace hard-coded 2.5.0 across 7 files with {{ capiscio_version }}
- Replace hard-coded 0.3.0 across 8 files with {{ protocol_version }}
- Convert badge.md from hand-written to mkdocstrings auto-generation
- Fix config.md Quick Start with correct SecurityConfig field names
- Remove stale VERIFIED timestamp comments from 4 reference files
- Skip go-api.md (auto-generated) and historical version table entries
Version changes now require editing only mkdocs.yml extra: config.
✅ Documentation Build SuccessfulThe documentation build completed successfully and passed validation checks.
|
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
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.
Phase 3: Automate Reference Docs
Part of the documentation remediation plan (Phase 3 of 4).
Changes
Version Variable Injection
hooks/version_vars.py— MkDocs hook that replaces{{ capiscio_version }}and{{ protocol_version }}placeholders with values frommkdocs.ymlextra:config{{ }}syntax in code examplesmkdocs.ymlextra:sectiongo-api.md(auto-generated by gomarkdoc),llms.txt(static file), and 3 historical "introduced in 0.3.0" table entries invalidation.mdBadge API Auto-Generation (mkdocstrings)
badge.mdfrom 442 lines of hand-written API docs to mkdocstrings auto-generationverify_badge,parse_badge,request_badge,request_badge_sync,request_pop_badge,request_pop_badge_sync,start_badge_keeper) now auto-generated from source docstringsBadgeClaims,VerifyResult,VerifyOptions,VerifyMode,TrustLevel) now auto-generatedConfig Quick Start Fix
config.mdQuick Start showing non-existent fields (validate_inbound,validate_outbound,require_signature,log_level)SecurityConfigconstructor:downstream,upstream,strict_mode,fail_modeStale Timestamp Cleanup
VERIFIED: 2025-12-xxHTML comment blocks fromgrpc.md,deployment.md,badge-ca.md,server/index.mdgit-revision-date-localizedplugin already provides accurate "last updated" datesBuild Verification
mkdocs buildpasses with zero errorscapiscio_versionorprotocol_versionreferences)Files Changed (19)
hooks/version_vars.pymkdocs.yml(hook config + version variables)badge.md(mkdocstrings conversion)config.md(Quick Start fix)