Skip to content

docs(user): serve the PDF manual from the stable release, not Pages. Principle VIII. - #6582

Open
ten9876 wants to merge 1 commit into
mainfrom
docs/pdf-from-release
Open

ten9876 wants to merge 1 commit into
mainfrom
docs/pdf-from-release

Conversation

@ten9876

@ten9876 ten9876 commented Oct 18, 2026

Copy link
Copy Markdown
Collaborator

Summary

The PDF manual is now 25.5 MiB. Cloudflare Pages accepts files of up to 25 MiB, so every Docs deploy on main since 2026-10-16 (7864ef544) has failed with:

Pages only supports files up to 25 MiB in size
AetherSDR-Manual.pdf is 25.5 MiB in size

That means docs.aethersdr.com has not updated since then.

  • docs.yml: the build still renders the PDF on every run, as a check, and still uploads it as an artifact on PRs. It now writes the PDF to $RUNNER_TEMP instead of docs/user/build/, so the deployed site no longer includes it. The release jobs, which attach and sign AetherSDR-Manual-<tag>.pdf, are unchanged.
  • docusaurus.config.js: a small postBuild plugin writes a _redirects file. It sends /AetherSDR-Manual.pdf with a 302 to releases/download/v<stable>/AetherSDR-Manual-v<stable>.pdf, with the version taken from stable-version.json, which release prep already updates. The site's links, build_pdf.py's web links and the app's Help → Printable Manual (PDF) URL in shipped builds all keep working.
  • docs/user/README.md: updated to describe the redirect.

One behavior change: /AetherSDR-Manual.pdf used to serve a manual typeset from main. It now serves the stable release's manual, the one that matches the site's default version. Between merging a release prep and publishing that release, the redirect points at a release that doesn't have the asset yet.

Test plan

  • npm ci --ignore-scripts && npm run build: build/_redirects is /AetherSDR-Manual.pdf https://github.com/aethersdr/AetherSDR/releases/download/v26.10.3/AetherSDR-Manual-v26.10.3.pdf 302, and build/ has no PDF
  • the redirect target returns 200
  • actionlint clean; zizmor findings unchanged from main
  • after merge: the main Docs run deploys, and curl -sI https://docs.aethersdr.com/AetherSDR-Manual.pdf returns 302 to the release asset

🤖 Generated with Claude Code

https://claude.ai/code/session_012U8wmr3AQGVrmQLp2zNBwa

…Principle VIII.

The manual is now 25.5 MiB, over the 25 MiB a Cloudflare Pages file may
be, so every main deploy since 2026-10-16 has failed on it and the site
has not updated.

The Docs build still renders the PDF, as a check, but outside the site's
build/, so the deploy no longer carries it. A _redirects file written
after the Docusaurus build sends /AetherSDR-Manual.pdf (302) to the copy
attached to the release stable-version.json names, so the site's links
and the app's Help menu link keep working. That copy is the stable
manual; the site used to serve one typeset from main.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012U8wmr3AQGVrmQLp2zNBwa
@ten9876
ten9876 requested review from a team as code owners October 18, 2026 23:43

This branch has not been deployed

No deployments
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