Repo docs layout
Where documentation lives in this monorepo — and what that means when you publish the dropbits/ tree (e.g. to Codeberg).
Paths
| Path | Role |
|---|---|
Repo-root docs/ | Normative / development — SPEC companions, OPEN-DECISIONS, DEPLOY, TOOLBOX, publish-manifest.json, … |
dropbits/docs/ | Public user + site-builder guides (Markdown sources and generated HTML + Pagefind) |
website/docs | Symlink → ../dropbits/docs |
website/ | Landing page + deploy scripts (docs:sync, docs:deploy) |
Contributor truth stays at repo-root SPEC.md and docs/. Public guides under dropbits/docs/ are what dropbits.org /docs/ serves.
After editing guides (monorepo only)
If you have the full product monorepo (this page’s relative links to website/ and repo-root docs/ resolve), rebuild published HTML from the monorepo root:
npm run docs:sync # MD → HTML + Pagefind under dropbits/docs/
npm run docs:deploy # optional — sync then rsync website/ to dropbits.orgA Codeberg / runtime-only clone does not include website/ or that npm pipeline — use the guides as shipped Markdown/HTML, or read dropbits.org/docs.
Codeberg implication
Publishing the dropbits/ tree (subtree export, release zip, or a branch whose root *is* the kernel) includes these public guides — Markdown and, if present, built HTML/Pagefind. Normative repo-root docs/ and the marketing website/ shell are not inside dropbits/ unless you push the whole monorepo.
Prefer a clean public tip: ship dropbits/ + LICENSE (+ a short root README aimed at operators: clone -b v8, migrate, seed-minimal, serve). Do not put monorepo docs:sync / website deploy steps in that root README. Keep Spec/OPEN-DECISIONS in the monorepo (or a separate contributor clone).
See also
- Get the kernel
- Site directory layout —
sites/<id>/trees (not this page) - Topology lock: docs/OPEN-DECISIONS.md (Release / docs)