diff options
| author | hathach <[email protected]> | 2026-06-30 14:39:57 +0700 |
|---|---|---|
| committer | hathach <[email protected]> | 2026-06-30 14:39:57 +0700 |
| commit | 20200b35202e5dd0a1a5e8be1db081dc57f6ae8e (patch) | |
| tree | 66592e56f6d7af39175b880d671a03ffa8a34ac3 | |
| parent | 0849a5c1722dfeaa1e576aa11259bd6274afe73c (diff) | |
docs: move changelog to docs/changelog, drop the docs/info folder
Relocate docs/info/changelog/ -> docs/changelog/ (docs/info held only the
changelog) and update all references: the toctree, README + MAINTAINERS links,
make_release.py, and the make-release skill.
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
| -rw-r--r-- | .claude/skills/make-release/SKILL.md | 10 | ||||
| -rw-r--r-- | MAINTAINERS.rst | 2 | ||||
| -rw-r--r-- | README.rst | 2 | ||||
| -rw-r--r-- | docs/changelog/0.10.0.rst (renamed from docs/info/changelog/0.10.0.rst) | 0 | ||||
| -rw-r--r-- | docs/changelog/0.10.1.rst (renamed from docs/info/changelog/0.10.1.rst) | 0 | ||||
| -rw-r--r-- | docs/changelog/0.11.0.rst (renamed from docs/info/changelog/0.11.0.rst) | 0 | ||||
| -rw-r--r-- | docs/changelog/0.12.0.rst (renamed from docs/info/changelog/0.12.0.rst) | 0 | ||||
| -rw-r--r-- | docs/changelog/0.13.0.rst (renamed from docs/info/changelog/0.13.0.rst) | 0 | ||||
| -rw-r--r-- | docs/changelog/0.14.0.rst (renamed from docs/info/changelog/0.14.0.rst) | 0 | ||||
| -rw-r--r-- | docs/changelog/0.15.0.rst (renamed from docs/info/changelog/0.15.0.rst) | 0 | ||||
| -rw-r--r-- | docs/changelog/0.16.0.rst (renamed from docs/info/changelog/0.16.0.rst) | 0 | ||||
| -rw-r--r-- | docs/changelog/0.17.0.rst (renamed from docs/info/changelog/0.17.0.rst) | 0 | ||||
| -rw-r--r-- | docs/changelog/0.18.0.rst (renamed from docs/info/changelog/0.18.0.rst) | 0 | ||||
| -rw-r--r-- | docs/changelog/0.19.0.rst (renamed from docs/info/changelog/0.19.0.rst) | 0 | ||||
| -rw-r--r-- | docs/changelog/0.20.0.rst (renamed from docs/info/changelog/0.20.0.rst) | 0 | ||||
| -rw-r--r-- | docs/changelog/0.21.0.rst (renamed from docs/info/changelog/0.21.0.rst) | 0 | ||||
| -rw-r--r-- | docs/changelog/0.5.0.rst (renamed from docs/info/changelog/0.5.0.rst) | 0 | ||||
| -rw-r--r-- | docs/changelog/0.6.0.rst (renamed from docs/info/changelog/0.6.0.rst) | 0 | ||||
| -rw-r--r-- | docs/changelog/0.7.0.rst (renamed from docs/info/changelog/0.7.0.rst) | 0 | ||||
| -rw-r--r-- | docs/changelog/0.8.0.rst (renamed from docs/info/changelog/0.8.0.rst) | 0 | ||||
| -rw-r--r-- | docs/changelog/0.9.0.rst (renamed from docs/info/changelog/0.9.0.rst) | 0 | ||||
| -rw-r--r-- | docs/changelog/index.rst (renamed from docs/info/changelog/index.rst) | 0 | ||||
| -rw-r--r-- | docs/index.rst | 2 | ||||
| -rwxr-xr-x | tools/make_release.py | 4 |
24 files changed, 10 insertions, 10 deletions
diff --git a/.claude/skills/make-release/SKILL.md b/.claude/skills/make-release/SKILL.md index 49ca29313..058d7245d 100644 --- a/.claude/skills/make-release/SKILL.md +++ b/.claude/skills/make-release/SKILL.md @@ -1,6 +1,6 @@ --- name: make-release -description: Use when cutting a new TinyUSB release — bumping the version, running tools/make_release.py, writing the per-release docs/info/changelog/ entry from the PRs merged since the last tag, and validating before the maintainer commits and tags. Covers the changelog PR-boundary reconciliation and the regenerated-file gotchas. +description: Use when cutting a new TinyUSB release — bumping the version, running tools/make_release.py, writing the per-release docs/changelog/ entry from the PRs merged since the last tag, and validating before the maintainer commits and tags. Covers the changelog PR-boundary reconciliation and the regenerated-file gotchas. --- # Cut a TinyUSB Release @@ -20,9 +20,9 @@ Gotchas: - `gen_doc` imports `pandas` + `tabulate` at line 3 and crashes before writing if they're missing (not in `docs/requirements.txt`) → `pip install pandas tabulate`. See the **build-doc** skill. - `boards.rst` is written with no trailing newline → pre-commit's `end-of-file-fixer` adds it; run pre-commit on the regenerated files (step 3). -## 2. Changelog — `docs/info/changelog/` (the hard part) +## 2. Changelog — `docs/changelog/` (the hard part) -Each release is its own file: create `docs/info/changelog/X.Y.Z.rst` and add it as the **first** entry in the `docs/info/changelog/index.rst` toctree (newest first). Determine the PR set by **git commit reachability, not by merge date** — a date query (`gh ... --search merged:>=DATE`) both includes the *previous* release's own changelog PR (its `mergedAt` shares the tag day) and is awkward at the boundary; `--merges | grep "Merge pull request"` silently drops squash-merged PRs. +Each release is its own file: create `docs/changelog/X.Y.Z.rst` and add it as the **first** entry in the `docs/changelog/index.rst` toctree (newest first). Determine the PR set by **git commit reachability, not by merge date** — a date query (`gh ... --search merged:>=DATE`) both includes the *previous* release's own changelog PR (its `mergedAt` shares the tag day) and is awkward at the boundary; `--merges | grep "Merge pull request"` silently drops squash-merged PRs. ```bash PREV=0.20.0 # last release tag @@ -42,7 +42,7 @@ Why this is correct: `$PREV..HEAD` excludes everything reachable from the last t A PR merged into a *feature branch* (rather than master) is folded into its parent top-level PR and won't appear on its own — intended (review follow-ups aren't double-listed), but make the parent's changelog bullet reflect the final merged state. This is also why a date-based `gh` query returns *more* numbers than this set: those extras are the prior changelog PR plus these sub-PRs. Then **curate** into the existing sections, matching the prior release file's RST style exactly: -- The file's title is the version (`X.Y.Z` with `======` underline matching its length), then the italic date (the planned tag date — ask if unknown). Add the file to the top of `docs/info/changelog/index.rst`. +- The file's title is the version (`X.Y.Z` with `======` underline matching its length), then the italic date (the planned tag date — ask if unknown). Add the file to the top of `docs/changelog/index.rst`. - Sections in order: **General** (New MCUs and Boards / Code Quality and Build / Documentation), **API Changes**, **Device Stack** (per class: Audio, CDC, HID, MIDI, MSC, MTP, Net, Video, …), **Host Stack**, **Controller Driver (DCD & HCD)** (per driver: DWC2, FSDEV, MUSB, RP2040, …), **Testing**, **Contributors**. Within a section, each driver/class group is a ``^^^``-underlined sub-heading (not a bullet). - RST inline code (double backticks) for symbols. Group related PRs into one bullet — summarize, don't dump 200 lines. Driver/`Port *` PR labels help bucket DCD/HCD entries. - **Contributors** section credits the release's PR authors (this is where contributor credit lives — there is no separate contributors page). List the unique non-bot author handles alphabetically: @@ -55,7 +55,7 @@ Then **curate** into the existing sections, matching the prior release file's RS ## 3. Validate (all unstaged) ```bash -pre-commit run --files docs/info/changelog/X.Y.Z.rst docs/info/changelog/index.rst \ +pre-commit run --files docs/changelog/X.Y.Z.rst docs/changelog/index.rst \ docs/reference/boards.rst docs/reference/dependencies.rst \ library.json repository.yml sonar-project.properties src/tusb_option.h tools/make_release.py python3 tools/build_doc.py -c # docs build clean; new release page wired into the toctree (see build-doc skill) diff --git a/MAINTAINERS.rst b/MAINTAINERS.rst index e9c063e08..6183e233e 100644 --- a/MAINTAINERS.rst +++ b/MAINTAINERS.rst @@ -6,5 +6,5 @@ Maintainers - `Zixun Li (HiFiPhile) <https://github.com/HiFiPhile>`__ — maintainer; audio expertise Everyone who has contributed is credited per release in the -`changelog <https://docs.tinyusb.org/en/latest/info/changelog/index.html>`__ and in the GitHub +`changelog <https://docs.tinyusb.org/en/latest/changelog/index.html>`__ and in the GitHub `contributors graph <https://github.com/hathach/tinyusb/graphs/contributors>`__. diff --git a/README.rst b/README.rst index bfe38234f..e5806bafc 100644 --- a/README.rst +++ b/README.rst @@ -355,7 +355,7 @@ The following tools are provided freely to support the development of the TinyUS :target: https://github.com/sponsors/hathach -.. _Changelog: docs/info/changelog/index.rst +.. _Changelog: docs/changelog/index.rst .. _Getting Started: docs/getting_started.rst .. _Supported Boards: docs/reference/boards.rst .. _Dependencies: docs/reference/dependencies.rst diff --git a/docs/info/changelog/0.10.0.rst b/docs/changelog/0.10.0.rst index 7c11dd176..7c11dd176 100644 --- a/docs/info/changelog/0.10.0.rst +++ b/docs/changelog/0.10.0.rst diff --git a/docs/info/changelog/0.10.1.rst b/docs/changelog/0.10.1.rst index 30f1bbd98..30f1bbd98 100644 --- a/docs/info/changelog/0.10.1.rst +++ b/docs/changelog/0.10.1.rst diff --git a/docs/info/changelog/0.11.0.rst b/docs/changelog/0.11.0.rst index c27b027dd..c27b027dd 100644 --- a/docs/info/changelog/0.11.0.rst +++ b/docs/changelog/0.11.0.rst diff --git a/docs/info/changelog/0.12.0.rst b/docs/changelog/0.12.0.rst index 65ac4741f..65ac4741f 100644 --- a/docs/info/changelog/0.12.0.rst +++ b/docs/changelog/0.12.0.rst diff --git a/docs/info/changelog/0.13.0.rst b/docs/changelog/0.13.0.rst index a860918d0..a860918d0 100644 --- a/docs/info/changelog/0.13.0.rst +++ b/docs/changelog/0.13.0.rst diff --git a/docs/info/changelog/0.14.0.rst b/docs/changelog/0.14.0.rst index 421e6d8d5..421e6d8d5 100644 --- a/docs/info/changelog/0.14.0.rst +++ b/docs/changelog/0.14.0.rst diff --git a/docs/info/changelog/0.15.0.rst b/docs/changelog/0.15.0.rst index f1d55f349..f1d55f349 100644 --- a/docs/info/changelog/0.15.0.rst +++ b/docs/changelog/0.15.0.rst diff --git a/docs/info/changelog/0.16.0.rst b/docs/changelog/0.16.0.rst index 7065f18ff..7065f18ff 100644 --- a/docs/info/changelog/0.16.0.rst +++ b/docs/changelog/0.16.0.rst diff --git a/docs/info/changelog/0.17.0.rst b/docs/changelog/0.17.0.rst index af9a486c3..af9a486c3 100644 --- a/docs/info/changelog/0.17.0.rst +++ b/docs/changelog/0.17.0.rst diff --git a/docs/info/changelog/0.18.0.rst b/docs/changelog/0.18.0.rst index 05dfd0579..05dfd0579 100644 --- a/docs/info/changelog/0.18.0.rst +++ b/docs/changelog/0.18.0.rst diff --git a/docs/info/changelog/0.19.0.rst b/docs/changelog/0.19.0.rst index dbda59e61..dbda59e61 100644 --- a/docs/info/changelog/0.19.0.rst +++ b/docs/changelog/0.19.0.rst diff --git a/docs/info/changelog/0.20.0.rst b/docs/changelog/0.20.0.rst index d5952a830..d5952a830 100644 --- a/docs/info/changelog/0.20.0.rst +++ b/docs/changelog/0.20.0.rst diff --git a/docs/info/changelog/0.21.0.rst b/docs/changelog/0.21.0.rst index bae39770e..bae39770e 100644 --- a/docs/info/changelog/0.21.0.rst +++ b/docs/changelog/0.21.0.rst diff --git a/docs/info/changelog/0.5.0.rst b/docs/changelog/0.5.0.rst index 676ae2fd0..676ae2fd0 100644 --- a/docs/info/changelog/0.5.0.rst +++ b/docs/changelog/0.5.0.rst diff --git a/docs/info/changelog/0.6.0.rst b/docs/changelog/0.6.0.rst index 5ec65f302..5ec65f302 100644 --- a/docs/info/changelog/0.6.0.rst +++ b/docs/changelog/0.6.0.rst diff --git a/docs/info/changelog/0.7.0.rst b/docs/changelog/0.7.0.rst index 664b323c8..664b323c8 100644 --- a/docs/info/changelog/0.7.0.rst +++ b/docs/changelog/0.7.0.rst diff --git a/docs/info/changelog/0.8.0.rst b/docs/changelog/0.8.0.rst index 38f51ba6b..38f51ba6b 100644 --- a/docs/info/changelog/0.8.0.rst +++ b/docs/changelog/0.8.0.rst diff --git a/docs/info/changelog/0.9.0.rst b/docs/changelog/0.9.0.rst index a48642144..a48642144 100644 --- a/docs/info/changelog/0.9.0.rst +++ b/docs/changelog/0.9.0.rst diff --git a/docs/info/changelog/index.rst b/docs/changelog/index.rst index 833008cd6..833008cd6 100644 --- a/docs/info/changelog/index.rst +++ b/docs/changelog/index.rst diff --git a/docs/index.rst b/docs/index.rst index c3cee41da..38cb4d870 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,7 +18,7 @@ troubleshooting faq maintainers - info/changelog/index + changelog/index .. toctree:: :maxdepth: 2 diff --git a/tools/make_release.py b/tools/make_release.py index fc118af14..b24fc69b2 100755 --- a/tools/make_release.py +++ b/tools/make_release.py @@ -64,6 +64,6 @@ gen_doc.gen_boards_doc() gen_presets.main() ################### -# docs/info/changelog/ +# docs/changelog/ ################### -print("Add docs/info/changelog/{}.rst and list it at the top of docs/info/changelog/index.rst".format(version)) +print("Add docs/changelog/{}.rst and list it at the top of docs/changelog/index.rst".format(version)) |
