Skip to content

Commit c2c0a0a

Browse files
committed
docs(skills): point the doc skills at the paths that exist
The skills still targeted a docs/en tree the site does not serve, a changelog sync script that was never added, and a breaking-changes page that does not exist. Also drops a bilingual parity check left over from the removed second locale, a duplicated verification command, and an example import that could not resolve from the package it was written for.
1 parent 6dab970 commit c2c0a0a

4 files changed

Lines changed: 21 additions & 30 deletions

File tree

.agents/skills/agent-core-dev/server-align.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,8 @@ packages/agent-core-v2/src/<domain>Legacy/
9494
Skeleton (matches `prompt/`):
9595

9696
```ts
97-
// prompt.ts — contract shaped by the v1 wire schema (agent-gateway/src/protocol)
98-
import type { PromptSubmitResult, PromptSubmission } from '../../protocol/rest-prompt';
97+
// prompt.ts — contract shaped by the v1 wire schema (@pymodel/protocol)
98+
import type { PromptSubmitResult, PromptSubmission } from '@pymodel/protocol';
9999
import { createDecorator, type ServiceIdentifier } from '#/_base/di/instantiation';
100100

101101
export interface IAgentPromptService {
@@ -204,7 +204,6 @@ Where the route mirrors v1, the test is the regression guard for the schema-fide
204204

205205
### 7. Verify
206206

207-
- `pnpm -C packages/agent-gateway test` — server routes green.
208207
- `pnpm -C packages/agent-gateway test` — server routes green (incl. any wire-schema guards).
209208
- `pnpm -C packages/agent-core-v2 test` — native + Legacy Service tests green.
210209
- `pnpm -C packages/agent-core-v2 run lint:imports` — the import boundaries (v1 ban, kosong subtree) still hold for a LegacyService.

.agents/skills/gen-docs/SKILL.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ For a **full pre-release audit** of all pages (detecting hallucinations and cove
1717

1818
This skill depends on the following being in place. If any are missing, stop and report to the user before continuing:
1919

20-
- `docs/` directory with `docs/en/` and `docs/.vitepress/config.ts` set up (VitePress site).
20+
- `docs/` directory with `docs/.vitepress/config.ts` set up (VitePress site).
2121
- `docs/AGENTS.md` style guide — defines source-of-truth rules, terminology table, typography, and writing style.
22-
- `docs/scripts/sync-changelog.mjs` — auto-syncs root `CHANGELOG.md` to `docs/en/release-notes/changelog.md`.
22+
- The `sync-changelog` skill — syncs `apps/pythinker-code/CHANGELOG.md` into `docs/release-notes/changelog.md`.
2323

2424
## Workflow
2525

@@ -40,41 +40,34 @@ This skill depends on the following being in place. If any are missing, stop and
4040

4141
If after the scan you conclude there is no user-facing impact, say so and stop.
4242

43-
3. **Sync English changelog**
43+
3. **Sync the changelog**
4444

45-
Run:
46-
47-
```bash
48-
node docs/scripts/sync-changelog.mjs
49-
```
50-
51-
This updates `docs/en/release-notes/changelog.md` from the root `CHANGELOG.md`. Never edit the docs changelog by hand.
45+
Run the `sync-changelog` skill. It curates `apps/pythinker-code/CHANGELOG.md`
46+
into `docs/release-notes/changelog.md`. Never edit the docs changelog by hand.
5247

5348
4. **Update user docs**
5449

55-
Following the rules in `docs/AGENTS.md`, edit the affected pages in whichever locale you are working in, then sync the mirror. Match terminology with the term table in `docs/AGENTS.md` and the existing wording in surrounding pages.
50+
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.
5651

5752
Cover all relevant sections:
5853

5954
- Guides (getting-started, use cases, interaction, sessions, IDE integration)
6055
- Customization (skills, agents, MCP, hooks, plugins, etc.)
6156
- Configuration (config files, env vars, providers, data locations)
6257
- Reference (CLI subcommands, slash commands, keyboard shortcuts)
63-
- Release notes (`docs/en/release-notes/breaking-changes.md` if a breaking change is involved)
58+
- Release notes (`docs/release-notes/changelog.md`, via the `sync-changelog` skill)
6459

6560
## Rules and conventions
6661

6762
- **Terminology**: Use the term table in `docs/AGENTS.md` exactly. Do not invent synonyms.
6863
- **Scope discipline**: Only update sections affected by the recent changes. Do not opportunistically rewrite unrelated docs.
6964
- **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`.
70-
- **Breaking changes**: If any change is breaking, also update `docs/en/release-notes/breaking-changes.md` (under `## Unreleased`) with `**Affected**` + `**Migration**` subsections.
71-
- **Do not edit auto-synced files**: `docs/en/release-notes/changelog.md` is regenerated by the sync script; any manual edit will be overwritten.
65+
- **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`.
66+
- **Do not edit auto-synced files**: `docs/release-notes/changelog.md` is regenerated by the sync script; any manual edit will be overwritten.
7267

7368
## Common mistakes
7469

7570
- Describing what code changed instead of what the user can now do (or can no longer do).
7671
- Adding a new section heading per feature instead of weaving the change into existing prose.
77-
- Updating only one locale and leaving its mirror stale.
78-
- Editing only the mirror to fix wording that should be corrected in the locale you changed first.
7972
- Inventing new terminology that drifts from the `docs/AGENTS.md` term table.
8073
- Using real internal values in examples instead of neutral `example` placeholders.

.agents/skills/sync-changelog/SKILL.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: sync-changelog
3-
description: Use after a release succeeds, when maintainers need to sync apps/pythinker-code/CHANGELOG.md into docs/en/release-notes/changelog.md, then open a PR on a dedicated branch.
3+
description: Use after a release succeeds, when maintainers need to sync apps/pythinker-code/CHANGELOG.md into docs/release-notes/changelog.md, then open a PR on a dedicated branch.
44
---
55

66
# Sync Changelog
@@ -20,7 +20,7 @@ After the release flow finishes (Release PR merged → `Version Packages` comple
2020
## When To Use
2121

2222
- A new version has been published to npm.
23-
- The top of `apps/pythinker-code/CHANGELOG.md` contains version blocks that are not yet in `docs/en/release-notes/changelog.md`.
23+
- The top of `apps/pythinker-code/CHANGELOG.md` contains version blocks that are not yet in `docs/release-notes/changelog.md`.
2424
- The `gen-docs` flow does not run this automatically; maintainers must explicitly do it after release.
2525

2626
Do **not** run this before the Release PR is merged. At that point, changesets has not yet written the new version into `apps/pythinker-code/CHANGELOG.md`.
@@ -30,7 +30,7 @@ Do **not** run this before the Release PR is merged. At that point, changesets h
3030
| File | Role | Edited by |
3131
|---|---|---|
3232
| `apps/pythinker-code/CHANGELOG.md` | **Only upstream source**, generated by changesets | Never edit manually |
33-
| `docs/en/release-notes/changelog.md` | English docs changelog; source of truth for docs | This skill |
33+
| `docs/release-notes/changelog.md` | English docs changelog; source of truth for docs | This skill |
3434

3535
Core rule: `apps/pythinker-code/CHANGELOG.md` is the only upstream source; the English docs changelog is what this skill writes.
3636

@@ -61,7 +61,7 @@ Before creating the branch, peek at the version range so the branch name matches
6161

6262
```bash
6363
rg '^## ' apps/pythinker-code/CHANGELOG.md | head -5
64-
rg '^## ' docs/en/release-notes/changelog.md | head -5
64+
rg '^## ' docs/release-notes/changelog.md | head -5
6565
```
6666

6767
Name the branch after the newest upstream version that is not yet in the English docs page:
@@ -238,14 +238,13 @@ Doc links: an entry that changes a documented config surface may end with a poin
238238
Review:
239239

240240
```bash
241-
git diff docs/en/release-notes/changelog.md
241+
git diff docs/release-notes/changelog.md
242242
```
243243

244244
Check:
245245

246246
- Every version heading carries its release date from the published tag, in half-width parentheses.
247-
- Each version has the same section set and order on both pages.
248-
- Each section has the same number of entries on both pages.
247+
- Section order within each version follows the canonical order.
249248
- Within each section, the most valuable, obvious, and larger entries appear before smaller or narrower entries.
250249
- Low-signal entries were collapsed into the single catch-all line, placed last under `Bug Fixes` — or under `Polish` when nothing folded is a fix (both the reader-action test and the channel test applied); the catch-all wording matches what was folded and never claims fixes that did not happen; section sizes stay within the density defaults (about 2 Polish, 3 Bug Fixes) unless extra qualifying entries were deliberately kept and flagged for review. The catch-all line ends with the upstream changelog pointer (file link, no version anchor).
251250
- PR links and commit hashes were stripped.
@@ -273,7 +272,7 @@ If the user chooses review:
273272
1. Show the uncommitted diff:
274273

275274
```bash
276-
git diff docs/en/release-notes/changelog.md
275+
git diff docs/release-notes/changelog.md
277276
```
278277

279278
2. Summarize synced versions, section counts, and anything that needed manual classification. List every entry folded into a catch-all line (short titles, one line each), any section that exceeds the density defaults, and every borderline call flagged during curation — the reviewer cannot own a cutoff they cannot see.
@@ -289,7 +288,7 @@ Only run this step when the user skipped review or confirmed review is complete.
289288
Stage only the changelog docs files:
290289

291290
```bash
292-
git add docs/en/release-notes/changelog.md
291+
git add docs/release-notes/changelog.md
293292
```
294293

295294
Use a neutral docs-sync commit message:
@@ -336,7 +335,7 @@ The docs-site changelog has not yet been synced for `<version range>` after the
336335

337336
## What changed
338337

339-
- Synced `<version range>` from `apps/pythinker-code/CHANGELOG.md` into `docs/en/release-notes/changelog.md`
338+
- Synced `<version range>` from `apps/pythinker-code/CHANGELOG.md` into `docs/release-notes/changelog.md`
340339
- Verified with `pnpm --filter docs run build`
341340

342341
## Checklist

.agents/skills/write-tui/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Themes are managed centrally under `src/tui/theme/`:
6868
- `bundle.ts` — packs `colors`, `styles`, `markdownTheme` into a `PythinkerTUIThemeBundle`.
6969
- `index.ts` / `detect.ts` — theme type and auto/dark/light resolution.
7070

71-
> **Keep the color-token set in sync.** `ColorPalette` in `colors.ts` is the source of truth for color tokens. When you add, rename, or remove one, update its mirrors in the same change: the custom-theme JSON schema (`apps/pythinker-code/src/tui/theme/theme-schema.json`), the token table in the custom-theme docs (`docs/en/customization/themes.md`), and the token table in the `custom-theme` built-in skill (`packages/agent-core/src/skill/builtin/custom-theme.md`).
71+
> **Keep the color-token set in sync.** `ColorPalette` in `colors.ts` is the source of truth for color tokens. When you add, rename, or remove one, update its mirrors in the same change: the custom-theme JSON schema (`apps/pythinker-code/src/tui/theme/theme-schema.json`), the token table in the custom-theme docs (`docs/customization/themes.md`), and the token table in the `custom-theme` built-in skill (`packages/agent-core/src/skill/builtin/custom-theme.md`).
7272
7373
Apply / switch flow:
7474

0 commit comments

Comments
 (0)