pixie / docs
SOURCE GUIDE GitHub ↗
Documentation

Static files. Ready to host.

Preview this site locally or publish it alongside the existing APT repository.

Preview locally

This site uses plain HTML, CSS, and a small JavaScript file. There is no package manager, build command, or remote font dependency. From the repository root, use an installed static server, for example Python:

python3 -m http.server 8000 --directory docs

Open http://localhost:8000/. You can also open docs/index.html directly; navigation and reading work without JavaScript.

The simplest repository setup: GitHub Pages

The release workflow already publishes the signed APT repository to GitHub Pages. It now copies docs/ into the same artifact at public/docs/, preserving the APT files at the root.

  1. In GitHub repository Settings → Pages, select GitHub Actions as the source.
  2. Configure the APT signing secrets required by .github/workflows/publish-apt.yml.
  3. Publish a version tag matching Cargo.toml when you intend to release.
  4. Open https://laflut3.github.io/Pixie/docs/ after the workflow succeeds.

Documentation deploys with that release workflow. The URL is the expected destination, not a claim that it is already live. Avoid a second Pages workflow that uploads only docs: it would replace the APT repository.

Any static host

Upload the contents of docs/ into a directory on your host. All local links are relative, so the site works at the domain root or under /docs/. HTTPS and cache policy belong to the host.

Use pixie.fleothing.com with Cloudflare Pages

  1. In Cloudflare, open Workers & Pages and create a Pages project from the laflut3/Pixie GitHub repository.
  2. Choose main as the production branch, set the build command to exit 0, and set the build output directory to docs.
  3. After the first deployment, open the project’s Custom domains tab, choose Set up a domain, and enter pixie.fleothing.com.
  4. Cloudflare will connect the subdomain to Pages. Confirm the suggested DNS record in the fleothing.com zone, then wait for the domain status to become active.

Future pushes to main redeploy the site. No build tool or separate documentation workflow is needed. See Cloudflare’s static Pages deployment guide and custom domain guide.

Maintain these pages

Use the same navigation and shared assets for new pages. Keep practical instructions in the user guide and feature behavior in How it works. Verify examples against current source and keep supported features distinct from planned ones. Relevant pages must be reviewed whenever runtime behavior, configuration, or deployment changes.

Pixie documentation Built from the source. Updated with the features.