docs-maintainer

Solid

Keep public Kandev docs current when code or behavior changes affect CLI commands, config keys, install/deploy flows, workflows, executors, APIs, screenshots, or user-facing terminology. Use this before finishing any change with public documentation impact, and when reviewing whether a change needs docs.

AI & Automation 494 stars 68 forks Updated today AGPL-3.0

Install

View on GitHub

Quality Score: 87/100

Stars 20%
90
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Docs Maintainer Use this skill to decide whether public docs need updates and to make those updates in the right place. ## Docs Boundaries - Public website docs source lives under `docs/public/**`. - Internal product/spec planning stays under `docs/specs/**`. - Implementation plans stay under `docs/plans/**`. - Architecture decisions stay under `docs/decisions/**`. - Raw supporting notes can remain under `docs/**` outside `docs/public/**`, but do not publish them unless rewritten for users. - `docs/public/meta.json` owns published-page order and navigation groups. Page paths own routes, and page frontmatter owns titles and descriptions. - The landing/docs website generates its content from this directory. Do not hand-edit generated files in the landing repository. ## When Docs Need Updates Check public docs when a change affects: - CLI commands, flags, install commands, or runtime launch behavior. - Configuration keys, environment variables, defaults, profiles, or feature flags. - Workspaces, workflows, tasks, agents, executors, worktrees, Git behavior, or review flows. - Docker, Kubernetes, service, desktop, remote environment, or Windows instructions. - Public APIs, WebSocket messages, workflow import/export schemas, or integration contracts. - Screenshots, visible UI labels, navigation, onboarding, or user-facing terminology. Skip public docs when the change is: - Purely internal refactoring with no behavior change. - Test-only, fixture-only, or build-only withou...

Details

Author
kdlbs
Repository
kdlbs/kandev
Created
6 months ago
Last Updated
today
Language
Go
License
AGPL-3.0

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Solid

doc-maintenance

Keep project docs aligned with recent code and feature changes — detect drift, update affected pages, and add release-relevant notes without rewriting unchanged sections.

9 Updated 1 weeks ago
getpaperclipai
API & Backend Featured

update-project-docs

MANDATORY for every coding agent (Claude Code, Codex, or any other) — keep this repository's documentation in sync after any change to behavior, configuration, interfaces, events, schema, or features. Use automatically (without being asked) at the end of ANY change-set that adds or alters an env var, event type, hook behavior, session/agent state transition, API route or response shape, DB schema, WebSocket message, MCP tool, CLI command, or user-facing feature — and whenever the user asks to "update the docs / README / wiki / architecture". Knows the full doc surface (README + VN/CN/KO, ARCHITECTURE, root index.html, wiki + i18n, server/client READMEs, docs/*) and which docs each kind of change touches.

850 Updated today
hoangsonww
AI & Automation Listed

update-docs

Audit and update every documentation surface in the APEX repo against the current state of skills, steering workflows, README marker tables, and the Docusaurus site under misc/website/. After any change to a skill (rename, retire, add, edit description), walk the repo, re-run script-managed surfaces if their --check fails, and reason through every tracked prose *.md to catch references that need updating. Use after adding/removing/renaming a skill, after editing SKILL.md frontmatter, after editing README marker blocks, or before publishing a docs change. Also use when the user says "update docs", "sync docs", "check docs", "run update-docs", or mentions that documentation might be stale.

37 Updated today
aws-samples