feat(docs): expand functions/ and completions/ in the Starlight home tree #118

2026-08-25T05:08:35Z

rootiest commented

2026-08-25 05:08:35 +00:00

Summary

The Home page's file tree used to show a one-line summary for functions/ and completions/ instead of their contents.
Both directories now list every file inline, generated live from the actual directory contents during --site generation — no manual upkeep needed when a function or completion is added/removed.
This only affects the Starlight site build; the plain-text manual/man page (--concat) still renders the compact one-line summary, since it never runs through the <FileTree> conversion.

Changes

docs/build-manual.py: added a COMPLETIONS constant and an EXPANDABLE_TREE_DIRS mapping; _as_file_tree() now lists real files (sorted, no per-file description) under any branch matching functions/ or completions/.
docs/verify-manual.py: added tests covering the expansion (using a temp directory, not the real 179-file directory) and confirming unrelated tree branches are left alone.

Test plan

python3 docs/verify-manual.py — 57/57 passed
python3 docs/build-manual.py --site — regenerated index.mdx and confirmed it lists every real file under functions/ and completions/
npx astro build in docs/site — 154 pages built, all internal links valid
python3 docs/build-manual.py --concat — confirmed the plain-text output still shows the one-line summary, unaffected

## Summary - The Home page's file tree used to show a one-line summary for `functions/` and `completions/` instead of their contents. - Both directories now list every file inline, generated live from the actual directory contents during `--site` generation — no manual upkeep needed when a function or completion is added/removed. - This only affects the Starlight site build; the plain-text manual/man page (`--concat`) still renders the compact one-line summary, since it never runs through the `<FileTree>` conversion. ## Changes - `docs/build-manual.py`: added a `COMPLETIONS` constant and an `EXPANDABLE_TREE_DIRS` mapping; `_as_file_tree()` now lists real files (sorted, no per-file description) under any branch matching `functions/` or `completions/`. - `docs/verify-manual.py`: added tests covering the expansion (using a temp directory, not the real 179-file directory) and confirming unrelated tree branches are left alone. ## Test plan - [x] `python3 docs/verify-manual.py` — 57/57 passed - [x] `python3 docs/build-manual.py --site` — regenerated `index.mdx` and confirmed it lists every real file under `functions/` and `completions/` - [x] `npx astro build` in `docs/site` — 154 pages built, all internal links valid - [x] `python3 docs/build-manual.py --concat` — confirmed the plain-text output still shows the one-line summary, unaffected

rootiest added 1 commit 2026-08-25 05:08:36 +00:00

feat(docs): expand functions/ and completions/ in the Starlight home tree 82d78d19f5

List every file in functions/ and completions/ inline under the home
page's file tree instead of a one-line summary. The listing is read
live off disk during --site generation, so it never needs manual
upkeep, and only affects the Starlight build — the plain-text
manual/man page (--concat) still renders the compact summary.

rootiest merged commit 2aad1aca98 into main

2026-08-25 05:35:33 +00:00

rootiest deleted branch feat/docs-filetree-dynamic-listing

2026-08-25 05:35:33 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: rootiest/fish-config#118