docs: virtualize crate READMEs under docs/components/
Each workspace crate's own README.md now also shows up as docs/components/<crate>.md via nix/packages/reference-docs.nix, so it renders on the docs site alongside the rest of docs/ without a second hand-copied file to keep in sync. Relative links that were correct from the crate's own position in the tree are rewritten for their new virtual position (../docs/x.md -> ../x.md, ../<sibling-crate> -> ./<sibling-crate>.md). Landing page at docs/components/README.md, nav bullet added to docs/README.md. No changes needed in the website repo's docs.nix - it already walks every subdirectory generically.
This commit is contained in:
parent
fc2f75fed1
commit
765bea2022
4 changed files with 90 additions and 9 deletions
|
|
@ -174,8 +174,10 @@ in
|
|||
# directory) and the website repo reuses it as a flake input,
|
||||
# neither of which needs the branding/prompt assets. See
|
||||
# ./reference-docs.nix. (`docs` below is the auto-generated
|
||||
# nix-options reference, a different artifact.)
|
||||
reference-docs = pkgs.callPackage ./reference-docs.nix { };
|
||||
# nix-options reference, a different artifact.) `self` is needed to
|
||||
# read each workspace crate's own README.md into the virtual
|
||||
# `components/` subdir.
|
||||
reference-docs = pkgs.callPackage ./reference-docs.nix { inherit self; };
|
||||
# XDG icon set + .desktop entries for hyperhive processes.
|
||||
# Narrow input: only the branding SVG, so unrelated source changes
|
||||
# don't bust this derivation's cache.
|
||||
|
|
|
|||
Loading…
Reference in a new issue