mara/hyperhive
mara/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Activity

reference-docs: the crate READMEs are exported under 4-implementation/crates

Browse source 
The docs sections moved the crate reference index to 4-implementation/crates,
but the derivation still wrote the per-crate pages to crates/ at the top of the
tree, so the website showed a separate top-level crates group. They now land
beside the index, and the links back into docs/ get one more ../.
This commit is contained in:
iris 2026-11-06 20:37:02 +01:00 • committed by mara
commit 0fbe137ace
1 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

22
nix/packages/reference-docs.nix
View file

@ -16,15 +16,15 @@
# `docs.nix` (website repo) needs no changes to pick either up — it # `docs.nix` (website repo) needs no changes to pick either up — it
# already walks every subdirectory generically. # already walks every subdirectory generically.
# #
# For crates that is `$out/crates/<crate>.md`, one per workspace crate # For crates that is `$out/4-implementation/crates/<crate>.md`, one per workspace crate
# with a README.md (mara's ask: "behaves as if hive-core/README.md lives # with a README.md (mara's ask: "behaves as if hive-core/README.md lives
# at docs/crates/hive-core.md" — lint:allow, a path this derivation # at docs/4-implementation/crates/hive-core.md" — lint:allow, a path this derivation
# creates in $out, so the repo has no such file). The crate's own README # creates in $out, so the repo has no such file). The crate's own README
# stays the single source of truth. # stays the single source of truth.
# #
# Output layout: # Output layout:
# $out/ — the repo docs/ tree verbatim # $out/ — the repo docs/ tree verbatim
# $out/crates/<crate>.md — one per workspace crate README # $out/4-implementation/crates/<crate>.md — one per workspace crate README
# $out/options/*.md — the nixosOptionsDoc bundle (`packages.docs`, # $out/options/*.md — the nixosOptionsDoc bundle (`packages.docs`,
# nix/docs/default.nix), copied verbatim — # nix/docs/default.nix), copied verbatim —
# already self-contained CommonMark, unlike # already self-contained CommonMark, unlike
@ -59,26 +59,26 @@ stdenv.mkDerivation {
runHook preInstall runHook preInstall
mkdir -p $out mkdir -p $out
cp -r ./* $out/ cp -r ./* $out/
mkdir -p "$out/crates" mkdir -p "$out/4-implementation/crates"
cp -r "$optionsMd" "$out/options" cp -r "$optionsMd" "$out/options"
for member in $members; do for member in $members; do
[ -f "$self/$member/README.md" ] || continue [ -f "$self/$member/README.md" ] || continue
# Rewrite relative links that were correct from the crate's own # Rewrite relative links that were correct from the crate's own
# position in the repo tree but aren't once the file is # position in the repo tree but aren't once the file is
# virtually one level under docs/ instead: # virtually two levels under docs/ instead:
# ../docs/x.md (crate root -> repo docs/) -> ../x.md lint:allow (stand-in name) # ../docs/x.md (crate root -> repo docs/) -> ../../x.md lint:allow (stand-in name)
# (crates/ -> docs/ is one directory shallower than # (4-implementation/crates/ -> docs/ is one directory deeper than
# <crate>/ -> docs/ was, so the leading docs/ segment drops) # <crate>/ -> docs/ was, so the leading docs/ segment becomes ../)
# ../<sibling-crate> (that crate's own directory, no file; forge # ../<sibling-crate> (that crate's own directory, no file; forge
# renders it as a directory listing) -> ./<sibling-crate>.md, # renders it as a directory listing) -> ./<sibling-crate>.md,
# since every crate README lives flat beside it under crates/. # since every crate README lives flat beside it under crates/.
fixups=(-e 's,\]\(\.\./docs/,](../,g') fixups=(-e 's,\]\(\.\./docs/,](../../,g')
for other in $members; do for other in $members; do
[ "$other" != "$member" ] || continue [ "$other" != "$member" ] || continue
fixups+=(-e "s,\]\(\.\./$other(/)?\),](./$other.md),g") fixups+=(-e "s,\]\(\.\./$other(/)?\),](./$other.md),g")
done done
sed -E "''${fixups[@]}" "$self/$member/README.md" >"$out/crates/$member.md" sed -E "''${fixups[@]}" "$self/$member/README.md" >"$out/4-implementation/crates/$member.md"
done done
runHook postInstall runHook postInstall
@ -87,7 +87,7 @@ stdenv.mkDerivation {
dontFixup = true; dontFixup = true;
meta = { meta = {
description = "hyperhive reference docs (the repo docs/ tree, plus virtual crates/<crate>.md and options/*.md subdirs)"; description = "hyperhive reference docs (the repo docs/ tree, plus virtual 4-implementation/crates/<crate>.md and options/*.md subdirs)";
homepage = "https://forge.darkest.space/hyperhive/hyperhive"; homepage = "https://forge.darkest.space/hyperhive/hyperhive";
}; };
} }