Update README and docs files with JSDoc comments and link validation.
npx skills add https://github.com/cpa03/blueprintify --skill docs-update-cpa03
Please help me install this Agent Skill. Skill: docs-update Source: https://github.com/cpa03/blueprintify/tree/main/.opencode/skill/docs-update Command: npx skills add https://github.com/cpa03/blueprintify --skill docs-update-cpa03
Documentation drift is common during feature releases and maintenance. This skill standardizes the process of updating user guides, API references, and developer notes to ensure consistency across the project.
Update the documentation to reflect the latest changes across README and docs/*.md, and add JSDoc comments to new functions.
High-intent search queries and answers about installing and using this skill.
To prevent documentation drift, you must synchronize changes across user guides, API references, and developer notes. This skill identifies the scope of user-facing versus dev-facing changes and updates relevant README and docs files to maintain consistency during maintenance cycles.
Updating README and docs files requires identifying affected documentation based on code changes. You update README.md for setup or usage modifications, modify docs/*.md files to reflect latest changes, and add JSDoc comments to new functions to improve maintainability.
Adding JSDoc comments and validating links ensures project docs remain accurate and maintainable. This skill enforces adding JSDoc to new functions and verifies links and formatting across README and docs/*.md to prevent broken references during feature releases.
Yes, this documentation update process works for both user-facing and dev-facing changes. It identifies the scope of changes to determine affected docs, ensuring synchronized updates to user guides and developer notes across the entire software project.
Documentation becomes inconsistent during software maintenance cycles because code changes outpace manual updates, causing drift. This skill standardizes the process of updating API references and developer notes to ensure consistency and prevent broken references.
Validating formatting and links across docs and README files prevents broken references and maintains accuracy. This skill verifies links and formatting in documentation files to ensure consistent references after synchronized changes are applied.
open-circleCreate API reference routes with index.mdx and properties.ts files.
brainbrewlabsPublishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.
Ahnd6474Audit TypeScript code and add missing JSDoc comments.
dimsourGenerate XML documentation, READMEs, and OpenAPI descriptions from .NET source code.
