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
Merged
Conversation
…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.
Contributor
Quality Report — ConductionNL/larpingapp @
|
| 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adopts the shared
@conduction/docusaurus-preset@^1.4.3for the LarpingApp docs site and moves it tolarpingapp.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.jsrewritten to callcreateConfig()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 viabaseFooterLinks().filter(...).minigames: falseto drop the canal-footer mini-games on this product-doc surface.docs/package.json+docs/package-lock.jsonadds@conduction/docusaurus-preset@^1.4.3.docs/src/pages/index.jsreplaces 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.jsnot.mdxto avoid the docs-plugin/pages-plugin scan collision.docs/static/CNAMElarpingapp.apptolarpingapp.conduction.nl..github/workflows/documentation.ymlcname:updated tolarpingapp.conduction.nl.URL change
Production docs URL moves from
https://larpingapp.apptohttps://larpingapp.conduction.nl. Old hardcodedlarpingapp.appreferences remain in the top-levelREADME.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.mdfeatures/pdf-export.mdfeatures/deep-link-registration.mdRather than expanding scope, they are added to
docs.excludein the new config; an MDX-cleanup follow-up PR can re-include them once escaped.Build outcome
npm run buildcompletes successfully against both locales (build/index.htmlandbuild/nl/index.htmlgenerated).app-downloads.json(resolved at sites/www/ build time) is non-fatal and present in the canonical openregister + mydash builds./privacy /terms /isoare inherited from the brand preset defaults and resolve once those pages are added (or overridden) site-wide.Test plan
docs/build/index.htmlanddocs/build/nl/index.htmlrender correctly on local preview.documentationbranch.larpingapp.appreferences in the top-level README.