Fullbleed documentation site

Published at https://docs.fullbleed.dev/ using GitHub Pages.

python -m pip install -r requirements.txt
rustup target add wasm32-wasip1
python tools/build_playground.py
node tools/verify_playground.mjs
python -m mkdocs build --strict
python tools/check_site.py site
python -m mkdocs serve

Changes to main build, check internal links and metadata, then deploy through .github/workflows/docs.yml. Pull requests run the same build checks without deployment.

The browser playground build needs Rust and Node 20 or newer. CI uses Rust 1.97.0 and Node 22. Its locked adapter compiles the published engine; it does not modify or vendor the engine source. See playground/README.md for limits, privacy behavior, and native/WASI verification.

Updating a release

Reference pages come from the engine repository's release tag. Keep hand-authored introductions and guides here; import API, CLI, CSS, architecture, print, and performance references with:

python tools/sync_reference.py --source /path/to/fullbleed-official --ref v2.5.4

docs/reference-source.json records the exact source commit. Use a built, installed release wheel to rerun examples and review the final PDFs and previews before replacing downloadable artifacts. docs/assets/examples/verification.json records the checks performed on published examples.

Run python -I tools/verify_quickstarts.py in an environment with that reference release installed. It executes the Python snippets directly from five introductory pages, checks their PDF text and page counts, and exercises the documented project commands. CI retains the PDFs, previews, and structured report. Older showcase, playground, and tutorial downloads keep their own verified release pins.

When changing the canonical domain, update site_url, docs/robots.txt, and this README, configure GitHub Pages, and verify DNS, HTTPS, sitemap URLs, and redirects. Keep the GitHub Pages URL until the custom domain is working.

Fullbleed is MIT licensed. Do not publish unsupported performance comparisons, standards conformance claims, or stale licensing statements. Retain old page URLs through the redirect map when consolidating reference material.

Search discovery

The site publishes an XML sitemap and crawlable canonical URLs. When the optional INDEXNOW_KEY repository secret is configured, deployment also hosts its ownership file for IndexNow. Keep the key out of source and logs. Pull-request builds do not receive it.

After a substantive content update or migration, notify IndexNow of the changed docs.fullbleed.dev URLs using its documented API. Do not repeatedly resubmit unchanged pages. An accepted notification means the URLs were received; it does not establish search indexing or ranking.