| name | docs-authoring |
| description | Use when a change affects user-visible behavior at docs.chronote.gg and needs public documentation. Covers where docs live (apps/docs-site vs docs/), authoring checklist, yarn docs:check, and Algolia config. Trigger when the user mentions docs, release notes, what's-new, or user-facing PR changes. |
Docs Authoring Workflow
Use this skill when a change affects user-visible behavior and needs public
documentation at docs.chronote.gg. Repo-specific workflow for creating or
updating docs in apps/docs-site.
This is the Claude Code mirror of .opencode/skills/docs-authoring/SKILL.md
and applies the same standing rules.
Standing rules
- Public product docs live in
apps/docs-site.
- Internal engineering notes and runbooks stay in
docs/.
- User-facing PRs must include a docs delta, unless
docs-exempt is explicitly used.
- Keep docs concise, actionable, and user-oriented.
Authoring checklist
- Identify user-facing behavior changes from code and issue scope.
- Update or add the relevant docs page in
apps/docs-site/docs/.
- Add or update links in sidebars/navigation when needed.
- For notable releases, update
apps/docs-site/docs/whats-new/index.md.
- Run docs validation:
yarn docs:check
- Confirm no broken links and no stale setup instructions.
Style expectations
- Use short headings and direct language.
- Prefer checklists and task-oriented steps.
- Avoid internal implementation details unless they are required for users.
- Keep examples realistic and minimal.
Search and deployment notes
- Algolia config uses
DOCS_ALGOLIA_APP_ID, DOCS_ALGOLIA_API_KEY, and DOCS_ALGOLIA_INDEX_NAME.
- If Algolia is not configured, local search can be used as the temporary fallback.
