Check and update repository documentation before pull requests are created.
npx skills add https://github.com/dmzoneill/skills --skill update-docs-dmzoneill
Please help me install this Agent Skill. Skill: update-docs Source: https://github.com/dmzoneill/skills/tree/main/update-docs Command: npx skills add https://github.com/dmzoneill/skills --skill update-docs-dmzoneill
This Skill ensures that your project's documentation is accurate and current, preventing outdated information from causing confusion or errors, especially before merging changes.
docs.enabled=true in config.json.Use the update-docs skill to check and update the documentation for the current repository.
High-intent search queries and answers about installing and using this skill.
To automatically update repository documentation before a pull request, run a skill that checks and updates READMEs, API docs, and mermaid diagrams. It scans for outdated information and broken links, ensuring your documentation accurately reflects recent changes.
Yes, you can automatically update mermaid diagrams and README files when code changes. The skill integrates with git to identify repository modifications and resolves the specifics to refresh outdated diagrams and documentation content before merging.
Automated documentation checking works with git repositories by integrating with knowledge tools to resolve repository specifics and identify changes. It scans enabled repositories for outdated documentation, broken links, and outdated diagrams, supporting automated commits for updates.
Yes, you need a specific configuration to enable automated documentation checks. The skill is designed exclusively for repositories with documentation enabled via configuration, specifically requiring `docs.enabled=true` in your `config.json` file to function properly.
The best way to keep API docs and READMEs current before merging code is to run an automated documentation check. This process verifies that your API documentation and READMEs accurately reflect the new feature changes, preventing outdated information from causing errors.
An automated repository scanner detects outdated documentation, broken links, and outdated diagrams. By scanning READMEs, API docs, and mermaid diagrams, it identifies discrepancies between the codebase and the documentation before a pull request is created.
jg-chalk-ioConfigure language, prompts, user profiles, and team settings in .moai/config/config.json.
p-o-ke-naeGuide GitHub Flow branching, commits, testing, pull requests, and squash merges.
majesticlabs-devGenerate syntactically valid Mermaid diagrams for flowcharts, sequence, class, state, Gantt, ER, and data lineage.
channgGenerate static documentation websites from markdown files with sidebar navigation.