Verification
Check what can be checked.
A practical verification map for this alpha documentation site and the Runebender Xilem source checkout. It records current checks without pretending that the project has a finished release QA process.
| Status | Alpha verification map |
|---|---|
| Audience | Contributors, maintainers, documentation agents |
| Source | Website repo, local source checkout, launch checklist |
| Stability | Expected to change when CI and release packaging settle |
Website checks
Use these checks after adding, moving, or renaming public pages.
pnpm run checkpnpm run buildpnpm run preview -- --host 127.0.0.1 --port 4322pnpm run check-links - Pages are generated from the docs content collection, so adding a new public docs route starts with a new file in
src/content/docs/. - The visible docs sidebar is grouped manually in
src/components/Sidebar.astro; add new public docs pages there when they belong in navigation. - Update
scripts/check-local-links.shso the new page is checked locally. - Update
public/llms.txtandpublic/llms-full.txtwhen the docs structure changes. - Review the built preview in the local browser for table overflow, sidebar wrapping, code block width, and the static cloud editor path.
External links
Use this check before public launch and after changing source, support, or historical-site links.
pnpm run check-external-links The external-link check intentionally excludes runebender.org until GitHub Pages and DNS are live. Published-site URLs are covered by the GitHub Pages and DNS checks below.
Published site
After GitHub Pages and DNS are active, verify the live site directly.
pnpm run check-published-site This check should pass before marking published-site checklist items complete or enabling HTTPS enforcement.
Source checks
Run source checks from the root of the Runebender Xilem repository, not from this website repository.
| Build/run | cargo run starts the source-first app path. |
|---|---|
| Open example | cargo run — assets/untitled.ufo checks opening the broad example UFO. |
| Hyperbezier example | cargo run — assets/hyper-matisse.ufo checks the hyperbezier-focused example. |
| Verbose logs | cargo run — —verbose gives more detail for bug reports. |
| Rust version | The current source manifest lists Rust 1.88. |
Manual checks
These are behavior checks, not automated promises.
- Open
assets/untitled.ufoand confirm glyph grid and editor navigation still match the docs. - Open
assets/hyper-matisse.ufobefore editing hyperbezier docs. - Check background image import and local tracing before editing tracing docs.
- Check QuiverAI notes against the README before changing cloud tracing documentation.
- Use Troubleshooting and Support to shape useful reports.
Not covered yet
Do not treat these as verified unless a future source workflow or CI job covers them.
- Cross-platform release packaging.
- Long-term shortcut stability.
- Round-trip compatibility across all UFO editors.
- Complete visual regression coverage for the app UI.
- Published-site checks after DNS and GitHub Pages are enabled.