mirror of
https://github.com/fluffos/fluffos
synced 2026-08-12 18:26:06 -04:00
89060c5a6b
* docs: fully-expandable generated sidebar, replacing index.md link pages
Rework docs navigation so the sidebar expands to every page of every
reference tree, instead of terminating at generated index.md link lists:
- New docs/gen_sidebar.py (replaces gen_index.py + update_index.sh):
walks efun/, apply/, stdlib/, concepts/, driver/, cli/ and zh-CN/ and
emits sidebars.generated.json — a full Docusaurus category tree per
directory. Category landing pages are now `generated-index` card pages
(title/description/slug), so all generated index.md files are deleted.
--check mode verifies freshness; new .github/workflows/docs-sidebar.yml
runs it in CI.
- New docs/sidebar_meta.json holds curated presentation: category labels,
one-line descriptions (shown on the landing cards), explicit ordering
(driver/cli/concepts read top-down from user-facing to internals) and
per-page label overrides.
- sidebars.ts becomes a hand-authored skeleton (Getting Started, lpc/,
Historical) that splices in the generated trees.
Content reorganization (from a docs-wide review):
- Move misplaced efun pages out of efun/general: terminal/protocol efuns
(act_mxp, send_zmp, request_term_*) to interactive/, debugging efuns
(check_memory, dump_*, clear_debug_level, destructed_objects) to
internals/, shallow_inherit_list to system/.
- Delete stub duplicates superseded by complete pages elsewhere:
general/parse_{add_synonym,dump,my_rules,remove}, contrib/{shuffle,
element_of}.
Modernize key pages with MDX:
- index.mdx: landing page with a card grid linking each doc section.
- build.mdx: per-platform <Tabs> (Ubuntu/macOS/Windows/Alpine+Docker),
admonitions, VitePress [[toc]] leftover removed, stale per-platform CI
workflow links updated to the unified ci.yml.
- ffi-plan.md: GitHub-style [!CAUTION] alert converted to an admonition.
`npm run build` passes clean (onBrokenLinks: throw, no warnings).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174GM2azvAHBmvyESwxm5om
* docs: serve the Chinese corpus through Docusaurus i18n
Move the zh-CN/ directory out of the default docs tree and into a proper
Docusaurus locale (i18n/zh-CN/docusaurus-plugin-content-docs/current/):
- The flat zh-CN/efun/ directory (333 pages) is re-homed to mirror the
categorized English layout (name-matched 1:1; `hash` maps to strings/
per its own frontmatter). apply/ pages map 1:1; the stray English-text
zh-CN/apply/master/view_errors.md documents a MudOS-era apply that no
longer exists in the driver and is dropped; stdlib/db/database_zh.md
becomes the i18n translation of stdlib/db/database.md; the Chinese
build guide becomes the translation of build.mdx.
- Untranslated pages automatically fall back to English content under
/zh-CN/, so the whole site is navigable in either locale from the new
navbar locale dropdown.
- Both locales share one sidebar. Generated sidebar items now carry
stable `key` fields (the directory/doc path) so translation keys are
unique (both efun/ and stdlib/ have an "Arrays" category, crypto and
strings both document `hash`). Category labels, generated-index
titles/descriptions, navbar and footer are translated in
i18n/zh-CN/...; theme UI strings come from Docusaurus' bundled
zh-Hans translations. Translated landing page at /zh-CN/.
- The "中文文档" sidebar section, the zh-CN tree in gen_sidebar.py /
sidebar_meta.json, and its slice of sidebars.generated.json are gone.
- Relative .md-file links on pages that render in both locales break
the localized build (the file->permalink map points at the localized
copy), so concepts/, the two socket_*_option pages and the config.md
generator now emit extension-less route links instead.
- zh interactive.md/objects.md get explicit slugs like their English
counterparts (a doc named after its parent directory is otherwise a
Docusaurus category-index doc, colliding with the generated-index
route).
`npm run build` builds both locales clean (onBrokenLinks: throw).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174GM2azvAHBmvyESwxm5om
---------
Co-authored-by: Claude <noreply@anthropic.com>
|
||
|---|---|---|
| .. | ||
| abs.md | ||
| add_a.md | ||
| assemble_class.md | ||
| base_name.md | ||
| classes.md | ||
| compressedp.md | ||
| copy.md | ||
| debug_message.md | ||
| disassemble_class.md | ||
| event.md | ||
| fetch_class_member.md | ||
| fetch_variable.md | ||
| file_length.md | ||
| function_owner.md | ||
| functions.md | ||
| get_garbage.md | ||
| get_os_env.md | ||
| heart_beats.md | ||
| is_daylight_savings_time.md | ||
| max.md | ||
| memory_summary.md | ||
| min.md | ||
| named_livings.md | ||
| network_stats.md | ||
| num_classes.md | ||
| pluralize.md | ||
| program_info.md | ||
| query_charmode.md | ||
| query_ip_port.md | ||
| query_multiple_short.md | ||
| query_notify_fail.md | ||
| query_num.md | ||
| query_replaced_program.md | ||
| real_time.md | ||
| reference_allowed.md | ||
| remove_charmode.md | ||
| remove_get_char.md | ||
| remove_interactive.md | ||
| remove_shadow.md | ||
| repeat_string.md | ||
| replace.md | ||
| replace_dollars.md | ||
| replace_html.md | ||
| replace_mxp.md | ||
| replace_objects.md | ||
| replaceable.md | ||
| restore_from_string.md | ||
| roll_MdN.md | ||
| roulette_wheel.md | ||
| send_nullbyte.md | ||
| set_os_env.md | ||
| set_prompt.md | ||
| store_class_member.md | ||
| store_variable.md | ||
| string_difference.md | ||
| terminal_colour.md | ||
| test_load.md | ||
| upper_case.md | ||
| variables.md | ||
| vowel.md | ||
| zonetime.md | ||