Skip to content

docs: refresh for Netclaw 0.28.2 (1/5): screenshots, generators, checks and sidebar - #140

Merged
Aaronontheweb merged 6 commits into
devfrom
docs/refresh-0.28-1-foundation
Oct 29, 2026
Merged

Aaronontheweb merged 6 commits into
devfrom
docs/refresh-0.28-1-foundation

Conversation

@Aaronontheweb

@Aaronontheweb Aaronontheweb commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Part 1 of 5 of the docs refresh for Netclaw 0.28.2. This is the PR that lands on dev. Parts 2 to 5 are stacked on top of it, and each one targets the branch below it.

Merge order: after review, merge top-down: #144 into #143, #143 into #142, #142 into #141, #141 into this PR, then this PR into dev. That way the site deploys once, with every page in place.

CI: expect this PR's build to fail until parts 2 to 5 are merged into it. The sidebar here lists pages that only exist in the later parts. Once they're merged into this branch, pr-validation runs against the complete set.

What's in this part

Everything outside src/content/docs:

  • Screenshots re-taken from the ghcr.io/netclaw-dev/netclaw:0.28.2 release image (87 PNGs/GIFs), plus the containerised capture stack under screenshots/ (seed scripts, compose files, Mattermost and MCP OAuth fixtures, Playwright page shots) and the VHS tapes.
  • Generators for the configuration reference and the tools reference (scripts/gen-config-reference.mjs, scripts/gen-tools-reference.mjs).
  • New checks: scripts/check-links.mjs (internal links and anchors) and scripts/check-rendered-pages.mjs, which fails the build when a page with a Mermaid diagram renders empty. The CI workflows install a cached headless Chromium so the diagrams render.
  • The sidebar entries for the new pages, public/_redirects for the moved Custom subagents page, and src/version.json now set to 0.28.2.
  • The examples/mattermost-compose stack that the new Mattermost tutorial uses.
  • Updates to the authoring guide (CLAUDE.md, AGENTS.md, the netclaw-docs skill).

How it was checked

Every page was re-verified against the 0.28.2 source. Commands, config blocks and compose files were run against the 0.28.2 image in throwaway containers. On the combined branch, npm run build, npm run check-links (25,000+ references, 188 pages, no broken links or anchors), the rendered-page check and check-docs-version all pass.

Not executed, kept because the source confirms them: steps that need a real Slack or Discord workspace or a cloud account. Cloudflare Access is a caution box for now, and #139 tracks testing a recommended setup.

Issues

GitHub closes issues only from a PR that merges into dev, so the full list lives here.

Fixes #112
Fixes #113
Fixes #105
Fixes #120
Fixes #117
Fixes #118
Fixes #124
Fixes #130
Fixes #115
Fixes #101
Fixes #102
Fixes #103

Partly covered, left open: #71 (no config-channels-resolve.png yet), #88 (covered across the CLI and configuration webhook pages, no standalone guide), #104, #123, #126, #127, #129, #136, #95.

…0.28 docs refresh

Re-taken screenshots from the 0.28.2 release image, the containerised capture
stack, the config and tools reference generators, the rendered-page and link
checks, the Mattermost compose example, and the sidebar entries for the new
pages that the following PRs add.
@Aaronontheweb
Aaronontheweb force-pushed the docs/refresh-0.28-1-foundation branch from ac4fdb9 to a24d637 Compare October 29, 2026 19:28
@Aaronontheweb
Aaronontheweb merged commit a444149 into dev Oct 29, 2026
4 checks passed
@Aaronontheweb
Aaronontheweb deleted the docs/refresh-0.28-1-foundation branch October 29, 2026 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment