docs(site): replace starter README and title synopsis fences

Swap the Starlight scaffold README for one describing this project's
two-source SSOT and dev/deploy workflow. Give the generated function
synopsis fence a Starlight filename title (`fish title="name.fish"`)
so it reads as a snippet of the function it documents.
This commit is contained in:
2026-07-26 05:01:01 -04:00
parent 4197e7faec
commit e20cff41d4
3 changed files with 33 additions and 42 deletions
+3 -1
View File
@@ -338,7 +338,9 @@ def test_prettify_splits_an_entry_block():
)
out = build_manual.prettify(body, "rm")
assert "```fish\nrm [-e | args...]\n```" in out, "synopsis was not fenced as fish"
assert '```fish title="rm.fish"\nrm [-e | args...]\n```' in out, (
"synopsis was not fenced as fish with a filename title"
)
assert "```fish\nrm file.txt" in out, "examples were not fenced as fish"
assert out.count("```") == 4, f"expected exactly two fences, got:\n{out}"
assert "\nSafe rm wrapper routing to trash:" in out, "description stayed indented"