You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
@@ -40,41 +40,34 @@ This skill depends on the following being in place. If any are missing, stop and
40
40
41
41
If after the scan you conclude there is no user-facing impact, say so and stop.
42
42
43
-
3.**Sync English changelog**
43
+
3.**Sync the changelog**
44
44
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.
52
47
53
48
4.**Update user docs**
54
49
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.
56
51
57
52
Cover all relevant sections:
58
53
59
54
- Guides (getting-started, use cases, interaction, sessions, IDE integration)
- 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)
64
59
65
60
## Rules and conventions
66
61
67
62
-**Terminology**: Use the term table in `docs/AGENTS.md` exactly. Do not invent synonyms.
68
63
-**Scope discipline**: Only update sections affected by the recent changes. Do not opportunistically rewrite unrelated docs.
69
64
-**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.
72
67
73
68
## Common mistakes
74
69
75
70
- Describing what code changed instead of what the user can now do (or can no longer do).
76
71
- 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.
79
72
- Inventing new terminology that drifts from the `docs/AGENTS.md` term table.
80
73
- Using real internal values in examples instead of neutral `example` placeholders.
Copy file name to clipboardExpand all lines: .agents/skills/sync-changelog/SKILL.md
+9-10Lines changed: 9 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
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.
4
4
---
5
5
6
6
# Sync Changelog
@@ -20,7 +20,7 @@ After the release flow finishes (Release PR merged → `Version Packages` comple
20
20
## When To Use
21
21
22
22
- 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`.
24
24
- The `gen-docs` flow does not run this automatically; maintainers must explicitly do it after release.
25
25
26
26
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
30
30
| File | Role | Edited by |
31
31
|---|---|---|
32
32
|`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 |
34
34
35
35
Core rule: `apps/pythinker-code/CHANGELOG.md` is the only upstream source; the English docs changelog is what this skill writes.
36
36
@@ -61,7 +61,7 @@ Before creating the branch, peek at the version range so the branch name matches
61
61
62
62
```bash
63
63
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
65
65
```
66
66
67
67
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
238
238
Review:
239
239
240
240
```bash
241
-
git diff docs/en/release-notes/changelog.md
241
+
git diff docs/release-notes/changelog.md
242
242
```
243
243
244
244
Check:
245
245
246
246
- 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.
249
248
- Within each section, the most valuable, obvious, and larger entries appear before smaller or narrower entries.
250
249
- 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).
251
250
- PR links and commit hashes were stripped.
@@ -273,7 +272,7 @@ If the user chooses review:
273
272
1. Show the uncommitted diff:
274
273
275
274
```bash
276
-
git diff docs/en/release-notes/changelog.md
275
+
git diff docs/release-notes/changelog.md
277
276
```
278
277
279
278
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.
289
288
Stage only the changelog docs files:
290
289
291
290
```bash
292
-
git add docs/en/release-notes/changelog.md
291
+
git add docs/release-notes/changelog.md
293
292
```
294
293
295
294
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
336
335
337
336
## What changed
338
337
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`
Copy file name to clipboardExpand all lines: .agents/skills/write-tui/SKILL.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,7 +68,7 @@ Themes are managed centrally under `src/tui/theme/`:
68
68
-`bundle.ts` — packs `colors`, `styles`, `markdownTheme` into a `PythinkerTUIThemeBundle`.
69
69
-`index.ts` / `detect.ts` — theme type and auto/dark/light resolution.
70
70
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`).
0 commit comments