Skip to content

Docs: shorter pages before 0.4.0, section links checked, release skill - #20

Merged
geeooff merged 11 commits into
mainfrom
docs-review-0.4.0
Oct 17, 2026
Merged

geeooff merged 11 commits into
mainfrom
docs-review-0.4.0

Conversation

@geeooff

@geeooff geeooff commented Oct 17, 2026

Copy link
Copy Markdown
Owner

The documentation review planned for this release: same facts, far fewer words. Each fact now lives on one page, and the other pages link to it.

Page Words before Words after
Getting started 2,645 957
How it works 3,377 1,369
Reference 3,056 1,534
FanControl recipe 2,447 758
README 523 255
Power plan recipe 365 212
[Unreleased] changelog 432 292

Changes

  • The design index's Today column is now the one place that says where each lot stands. The status paragraphs of Lots 8, 13, 14 and 17 are shortened; the history stays in each page's body.
  • The recipes index is shorter.
  • The pages now agree with each other and with the code:
    • check --pid is documented;
    • the number of naming attempts is "six attempts in all" everywhere;
    • "fan curves" replaces "profile" for FanControl.
  • build.ps1 test now checks that each link's #section exists. It used to check only the file, so a link to a renamed heading passed and landed at the top of the page.
  • The release procedure moves from AGENTS.md, which is loaded in every session, into .claude/skills/release/SKILL.md. AGENTS.md keeps a one-line pointer to it.

Verified

  • build.ps1 test passes, and the new section check catches two broken anchors planted on purpose.
  • The external links were checked by hand: all return 200.

🤖 Generated with Claude Code

geeooff and others added 11 commits October 17, 2026 12:03
2,645 words to 957. Each fact once; details left to the reference and How
it works, which the page links.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
523 words to 255; installing details now live in Getting started only.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
3,377 words to 1,369. History and reasoning stay in the design record, which the page links.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
3,056 words to 1,534. Each command, setting and file in one row; the long prose around them gone.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2,447 words to 758. The script and the XML import stay; the click-by-click Task Scheduler route goes, its settings kept in the closing table.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
365 words to 212.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The index's status column becomes the one place for what holds now; the long status paragraphs of Lots 8, 13, 14 and 17 shrink to that, the history left in their bodies.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
432 words to 292, one short line per change, and a line for the shorter documentation.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…rywhere

The index drops the steps each recipe already has; the example configuration says six attempts in all, as the reference and the code do.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
build.ps1 resolved a link's file and ignored its #section, so a link to a renamed heading passed and landed at the top of the page. It now computes GitHub's anchors for each page and refuses one that is missing.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The steps were spread over AGENTS.md, loaded in every session, and memory. They now live in .claude/skills/release/SKILL.md, read only when a release is made, with the checks before, the commit, the tag and the field checks after; AGENTS.md points to it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@geeooff
geeooff merged commit b459063 into main Oct 17, 2026
1 check passed
@geeooff
geeooff deleted the docs-review-0.4.0 branch October 17, 2026 12:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant