xh-update-docs

Automating documentation updates for hoist-react involves analyzing commits or pull requests to identify modified files, mapping them to affected packages, and proposing targeted edits to READMEs and the doc registry. This process ensures documentation stays accurately synced with code changes.

Automated documentation generation maps code changes by identifying new or modified files in commits, cross-referencing changelogs to find documentation-worthy updates, and applying proposed changes directly to the relevant package READMEs and the documentation index.

You can update the documentation roadmap automatically after adding a new component. The process identifies the new files, updates the package README and documentation index, and adds a corresponding entry to the docs planning roadmap file to track ongoing documentation needs.

Automated documentation synchronization modifies package READMEs, AGENTS.md, the documentation index at docs/README.md, the document registry at docs/doc-registry.json, and the documentation roadmap located at docs/planning/docs-roadmap.md.

You do not need to manually cross-reference changelogs to generate documentation. The automation cross-references changelogs internally to determine documentation-worthy updates, then proposes and applies the necessary changes to the relevant documentation files.