docs: move prose documentation into docs/ so the docs site publishes it
CI / flake (push) Skipped
CI / flake (pull_request) Successful in 4m21s
CI / flake (push) Skipped
CI / flake (pull_request) Successful in 4m21s
The docs-site build syncs this repo's README.md and docs/ into the site tree; nothing else is copied. All prose apart from the README therefore lived outside the sync and never appeared on https://docs.lyrapup.pet/nixfiles/, and the one page that did publish carried 18 link targets that resolved to nothing. Moves: home/README.md -> docs/shell.md home/KEYBINDINGS.md -> docs/keybindings.md hosts/<Name>/README.md -> docs/hosts/<name>.md docs/.pages and docs/hosts/.pages give the awesome-pages plugin an explicit order; new pages are picked up by the trailing '...' without an edit. Links are rewritten so a single URL is correct in both Gitea and the published site: absolute Gitea source URLs for .nix files and directories, relative links between pages under docs/, and absolute docs.lyrapup.pet URLs from the root README, which the build republishes at a different depth from the rest of the tree. In-code comments that pointed at a moved README are updated to the new path. The README gains a Documentation section covering the sync contract and the linking rules, and CLAUDE.md carries the short version so future edits do not reintroduce unsynced pages or dead links. Verified by reproducing the docs-site assembly locally against its pinned toolchain (mkdocs 1.6.1, mkdocs-material 9.7.7, awesome-pages 2.10.1): pages render at the URLs used above and in the declared order.
This commit is contained in:
@@ -42,6 +42,17 @@ prettier formats `*.md`, so **documentation edits must be run through `nix fmt`*
|
||||
exactly like code. prettier re-aligns Markdown tables in particular; hand-editing
|
||||
a table almost always leaves it non-conformant and fails the `formatting` check.
|
||||
|
||||
Prose documentation lives in `docs/` and is **published** to
|
||||
<https://docs.lyrapup.pet/nixfiles/> by the separate `docs-site` repo, which
|
||||
clones this one at build time. Two consequences when editing docs:
|
||||
|
||||
- A markdown file outside `docs/` (other than the root `README.md`) is not
|
||||
synced and will never appear on the site. Put new prose in `docs/`.
|
||||
- Links must follow the rules in the README's "Documentation" section: absolute
|
||||
Gitea URLs to source files, relative links between `docs/` pages, and
|
||||
absolute `docs.lyrapup.pet` URLs from the root README into `docs/`. The site
|
||||
builds non-strict, so a broken link is silent.
|
||||
|
||||
The CI `formatting` step runs on **every** PR — including docs- and config-only
|
||||
changes — so a Markdown/YAML/JSON edit is format-checked before merge, not just
|
||||
after it lands on `main`. (The heavier `deadnix`/`statix`/`pre-commit` lints and
|
||||
|
||||
Reference in New Issue
Block a user