PyModel/pythinker-code / .agents/skills/gen-docs
gen-docs
VerifiedUpdate Pythinker Code CLI user documentation after meaningful code changes that affect product behavior or user experience.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 3.7 KB |
SKILL.md
View on GitHub---
name: gen-docs
description: Update Pythinker Code CLI user documentation after meaningful code changes that affect product behavior or user experience.
---
# Gen Docs
## Overview
This repository maintains English-only user documentation under `docs/`.
Use this skill to update the corresponding documentation whenever the codebase has changes that affect product behavior or user experience.
For a **full pre-release audit** of all pages (detecting hallucinations and coverage gaps), use the `audit-docs` skill instead.
## Prerequisites
This skill depends on the following being in place. If any are missing, stop and report to the user before continuing:
- `docs/` directory with `docs/.vitepress/config.ts` set up (VitePress site).
- `docs/AGENTS.md` style guide — defines source-of-truth rules, terminology table, typography, and writing style.
- The `sync-changelog` skill — syncs `apps/pythinker-code/CHANGELOG.md` into `docs/release-notes/changelog.md`.
## Workflow
1. **Inspect changes**
- `git log main..HEAD --oneline` — commits on the current branch
- `git diff main..HEAD --stat` — file-level scope
- `ls .changeset/*.md` (excluding `README.md`) — pending changeset entries
- Read `CHANGELOG.md` and any subpackage `packages/*/CHANGELOG.md` for already-recorded entries.
2. **Understand user-facing impact**
For each change, read the actual implementation when needed; **do not infer behavior from commit messages or PR titles alone**. Skip:
- Internal refactors with no externally visible behavior change
- Tests, CI, type-only changes
- Tooling / build-system changes that do not change how users invoke the CLI
If after the scan you conclude there is no user-facing impact, say so and stop.
3. **Sync the changelog**
Run the `sync-changelog` skill. It curates `apps/pythinker-code/CHANGELOG.md`
into `docs/release-notes/changelog.md`. Never edit the docs changelog by hand.
4. **Update user docs**
Following the rules in `docs/AGENTS.md`, edit the affected pages under `docs/`. Match terminology with the term table in `docs/AGENTS.md` and the existing wording in surrounding pages.
Cover all relevant sections:
- Guides (getting-started, use cases, interaction, sessions, IDE integration)
- Customization (skills, agents, MCP, hooks, plugins, etc.)
- Configuration (config files, env vars, providers, data locations)
- Reference (CLI subcommands, slash commands, keyboard shortcuts)
- Release notes (`docs/release-notes/changelog.md`, via the `sync-changelog` skill)
## Rules and conventions
- **Terminology**: Use the term table in `docs/AGENTS.md` exactly. Do not invent synonyms.
- **Scope discipline**: Only update sections affected by the recent changes. Do not opportunistically rewrite unrelated docs.
- **Public examples**: Never write real internal endpoints, key names, account names, or service names into docs. Use neutral placeholders such as `https://api.example.com/v1`, `https://registry.example.com/v1/models/api.json`, `example.test`, and `YOUR_API_KEY`.
- **Breaking changes**: If any change is breaking, say so in the changeset and describe the migration there; the changelog carries it into `docs/release-notes/changelog.md`.
- **Do not edit auto-synced files**: `docs/release-notes/changelog.md` is regenerated by the sync script; any manual edit will be overwritten.
## Common mistakes
- Describing what code changed instead of what the user can now do (or can no longer do).
- Adding a new section heading per feature instead of weaving the change into existing prose.
- Inventing new terminology that drifts from the `docs/AGENTS.md` term table.
- Using real internal values in examples instead of neutral `example` placeholders.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 466k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 196k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |