Skip to content
This repository was archived by the owner on May 29, 2026. It is now read-only.

feat(docs): adopt @conduction/docusaurus-preset + move to larpingapp.conduction.nl#124

Merged
rubenvdlinde merged 1 commit into
developmentfrom
feature/conduction-nl-migration
May 7, 2026
Merged

feat(docs): adopt @conduction/docusaurus-preset + move to larpingapp.conduction.nl#124
rubenvdlinde merged 1 commit into
developmentfrom
feature/conduction-nl-migration

Conversation

@rubenvdlinde

Copy link
Copy Markdown
Contributor

Summary

Adopts the shared @conduction/docusaurus-preset@^1.4.3 for the LarpingApp docs site and moves it to larpingapp.conduction.nl. Mirrors the openregister + mydash docs migrations (canonical example: ConductionNL/openregister#1444).

The docs site now inherits brand defaults (tokens, Navbar/Footer swizzles, KvK/BTW copyright, hex-watermark hero) and gets a brand-aligned landing page composed from <DetailHero> + <WidgetShelf>.

Changes

  • docs/docusaurus.config.js rewritten to call createConfig() from @conduction/docusaurus-preset. Keeps larpingapp-specific bits: NL+EN i18n, mermaid theme, custom prism themes, Documentation+GitHub navbar items. Footer reduced to the brand "Conduction" column via baseFooterLinks().filter(...). minigames: false to drop the canal-footer mini-games on this product-doc surface.
  • docs/package.json + docs/package-lock.json adds @conduction/docusaurus-preset@^1.4.3.
  • docs/src/pages/index.js replaces the homepage with <DetailHero> (line-chart spike icon, orange accent, Install/Docs/GitHub CTAs) + a 3-card <WidgetShelf> (My character, Upcoming sessions, Recent scenes). Authored as .js not .mdx to avoid the docs-plugin/pages-plugin scan collision.
  • docs/static/CNAME larpingapp.app to larpingapp.conduction.nl.
  • .github/workflows/documentation.yml cname: updated to larpingapp.conduction.nl.

URL change

Production docs URL moves from https://larpingapp.app to https://larpingapp.conduction.nl. Old hardcoded larpingapp.app references remain in the top-level README.md (badge link, documentation link, directory comment) flagged for a follow-up sweep, not changed in this PR to keep the diff scoped.

Pre-existing MDX-3 issues excluded from build

Three feature-reference markdown files contain raw {token} patterns the Docusaurus 3.7 MDX parser interprets as JSX expressions ({type}_register, {characterName}_character_sheet.pdf, /characters/{uuid}):

  • features/object-service.md
  • features/pdf-export.md
  • features/deep-link-registration.md

Rather than expanding scope, they are added to docs.exclude in the new config; an MDX-cleanup follow-up PR can re-include them once escaped.

Build outcome

  • npm run build completes successfully against both locales (build/index.html and build/nl/index.html generated).
  • Pre-existing preset warning about app-downloads.json (resolved at sites/www/ build time) is non-fatal and present in the canonical openregister + mydash builds.
  • Footer-link warnings for /privacy /terms /iso are inherited from the brand preset defaults and resolve once those pages are added (or overridden) site-wide.

Test plan

  • Confirm docs/build/index.html and docs/build/nl/index.html render correctly on local preview.
  • Verify the larpingapp.conduction.nl DNS / GitHub Pages routing once a maintainer merges and the documentation workflow runs from the documentation branch.
  • Open follow-up issue to clean up MDX-3 escaping in the 3 excluded feature markdown files.
  • Open follow-up issue to sweep remaining larpingapp.app references in the top-level README.

…conduction.nl

Adopts the shared @conduction/docusaurus-preset@^1.4.3 for the
LarpingApp docs site and moves it to larpingapp.conduction.nl. Mirrors
the openregister + mydash docs migrations (canonical example:
ConductionNL/openregister#1444).

The docs site now inherits brand defaults (tokens, Navbar/Footer
swizzles, KvK/BTW copyright, hex-watermark hero) and gets a
brand-aligned landing page composed from <DetailHero> + <WidgetShelf>.

Changes
- docs/docusaurus.config.js -- rewritten to call createConfig() from
  @conduction/docusaurus-preset. Keeps larpingapp-specific bits: NL+EN
  i18n, mermaid theme, custom prism themes, Documentation+GitHub navbar
  items. Footer reduced to the brand "Conduction" column via
  baseFooterLinks().filter(...). minigames: false to drop the
  canal-footer mini-games on this product-doc surface.
- docs/package.json + docs/package-lock.json -- adds
  @conduction/docusaurus-preset@^1.4.3.
- docs/src/pages/index.js -- replaces the homepage with <DetailHero>
  (line-chart spike icon, orange accent, Install/Docs/GitHub CTAs) +
  a 3-card <WidgetShelf> (My character, Upcoming sessions, Recent
  scenes). Authored as .js not .mdx to avoid the docs-plugin /
  pages-plugin scan collision.
- docs/static/CNAME -- larpingapp.app -> larpingapp.conduction.nl.
- .github/workflows/documentation.yml -- cname: updated to
  larpingapp.conduction.nl.

URL change

Production docs URL moves from https://larpingapp.app to
https://larpingapp.conduction.nl. Old hardcoded larpingapp.app
references remain in the top-level README.md (badge link, doc link,
directory comment) -- flagged for a follow-up sweep, not changed in
this PR to keep the diff scoped.

Pre-existing MDX-3 issues excluded from build

Three feature-reference markdown files contain raw `{token}` patterns
the Docusaurus 3.7 MDX parser interprets as JSX expressions
(features/object-service.md, features/pdf-export.md,
features/deep-link-registration.md). Rather than expanding scope, they
are added to docs.exclude in the new config; an MDX-cleanup follow-up
PR can re-include them once escaped.
@rubenvdlinde rubenvdlinde merged commit cce8705 into development May 7, 2026
24 of 32 checks passed
@rubenvdlinde rubenvdlinde deleted the feature/conduction-nl-migration branch May 7, 2026 20:51
@github-actions

github-actions Bot commented May 7, 2026

Copy link
Copy Markdown
Contributor

Quality Report — ConductionNL/larpingapp @ 48d3c5b

Check PHP Vue Security License Tests
lint
phpcs
phpmd
psalm
phpstan
phpmetrics
eslint
stylelint
composer ✅ 94/94
npm
PHPUnit ⏭️
Newman ⏭️
Playwright ⏭️

Quality workflow — 2026-05-07 20:51 UTC

Download the full PDF report from the workflow artifacts.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant