Help: Learn more opens the manual at docs.inbuxa.org

jcoffey-dev commented

2026-10-06 01:44:00 +00:00

Owner

The console side of the admin manual (admin UX roadmap, pinned: "each tooltip gets a Learn more link to a detailed page in an online admin manual built on MkDocs"). The manual itself is inbuxa.org #53 (docs.inbuxa.org/reference/).

src/help/manual.ts: the public manual (https://docs.inbuxa.org) is the default, so every tooltip and help panel now shows Learn more. <meta name="manual-url"> still names a deployment's own manual; an empty one turns the links off. manualPath() / manualPage() split out and shared with the generator. JMAP objects outside the registry get a jmap- prefix (AddressBook vs x:AddressBook would otherwise share a page).
tools/build-manual.mjs (npm run manual): writes the reference from the server schema and this console's own help texts (loaded through Vite, so @/ resolves): one page per settings object or kind, an anchor per option, defaults worded like the tooltips, an index by console menu. Regenerate after a schema or help change and commit the result in inbuxa.org.

Strings: none new in the console.

Checked: npm test (607; help tests updated for the default and the empty tag, plus the jmap- case), typecheck, lint, i18n check, build. Against the generated site: all 2,235 help ids resolve to a page and anchor; mkdocs build --strict clean.

The console side of the admin manual (admin UX roadmap, pinned: "each tooltip gets a Learn more link to a detailed page in an online admin manual built on MkDocs"). The manual itself is inbuxa.org #53 (docs.inbuxa.org/reference/). - **`src/help/manual.ts`:** the public manual (`https://docs.inbuxa.org`) is the default, so every tooltip and help panel now shows **Learn more**. `<meta name="manual-url">` still names a deployment's own manual; an empty one turns the links off. `manualPath()` / `manualPage()` split out and shared with the generator. JMAP objects outside the registry get a `jmap-` prefix (`AddressBook` vs `x:AddressBook` would otherwise share a page). - **`tools/build-manual.mjs`** (`npm run manual`): writes the reference from the server schema and this console's own help texts (loaded through Vite, so `@/` resolves): one page per settings object or kind, an anchor per option, defaults worded like the tooltips, an index by console menu. Regenerate after a schema or help change and commit the result in inbuxa.org. **Strings:** none new in the console. **Checked:** `npm test` (607; help tests updated for the default and the empty tag, plus the `jmap-` case), typecheck, lint, i18n check, build. Against the generated site: all 2,235 help ids resolve to a page and anchor; `mkdocs build --strict` clean.

jcoffey-dev added 1 commit 2026-10-06 02:15:22 +00:00

Help: "Learn more" opens the manual at docs.inbuxa.org

ci / build (pull_request) Skipped

Details

github/ci (branch) GitHub Actions

Details

ci / github (pull_request) Successful in 1m4s

Details

ci / publish (pull_request) Skipped

Details

ci / notices (pull_request) Successful in 1m35s

Details

2cd9b4b1ba

Every tooltip and help panel already carried a stable id; the manual
behind them now exists (inbuxa.org #53, docs.inbuxa.org/reference/).

- manual.ts: the public manual is the default. <meta name="manual-url">
  still names a deployment's own, and an empty tag turns the links off.
  manualPath() and manualPage() are split out so the generator names its
  pages with the same rules the links use. The JMAP objects that aren't
  the registry's (AddressBook, Calendar…) get `jmap-` first, or they'd
  share a page with the settings of the same name.
- tools/build-manual.mjs (`npm run manual`): writes the reference from
  the server's schema and this console's own help texts, loaded through
  Vite: a page per settings object or kind, an anchor per option, the
  default worded as the tooltip words it, and an index by menu.

jcoffey-dev force-pushed feat/admin-manual from 1c69ca2693 to 2cd9b4b1ba

2026-10-06 02:15:22 +00:00

Compare

jcoffey-dev merged commit 701d44c22e into main

2026-10-06 02:17:00 +00:00

jcoffey-dev deleted branch feat/admin-manual

2026-10-06 02:17:00 +00:00

Help: Learn more opens the manual at docs.inbuxa.org #85