cyberneticlibrary

Sync documentation with code changes

branch-docs-syncskillsetup L16
juvenal/openrender
What it does

Synchronize documentation with code refactors, features, and breaking changes via git analysis

Best for

Keeping developer notes and user docs in sync with recent code changes and refactors

Inputs
  • · git commit range
  • · project documentation structure (DEVNOTES, docs/site, README, man)
Outputs
  • · updated DEVNOTES.md
  • · refreshed site docs
  • · revised README/ChangeLog/NEWS
Requires
  • · git log/show
  • · documentation files (markdown, man pages)
Preconditions
  • · standard documentation layout
  • · git history accessible
Failure modes
  • · batch renames lose casing
  • · internal links break if not audited
Trust signals
  • · surgical edit approach (enough context)
  • · audit phase for stale references
  • · case-preserving renames