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 openregister.conduction.nl#1444

Merged
rubenvdlinde merged 0 commit into
documentationfrom
feature/conduction-nl-migration
May 8, 2026
Merged

feat(docs): adopt @conduction/docusaurus-preset + move to openregister.conduction.nl#1444
rubenvdlinde merged 0 commit into
documentationfrom
feature/conduction-nl-migration

Conversation

@rubenvdlinde

Copy link
Copy Markdown
Contributor

Summary

Adopts the shared @conduction/docusaurus-preset@^1.4.3 for the OpenRegister docs site and moves it to openregister.conduction.nl. Mirrors the mydash docs migration that just shipped (canonical example: ConductionNL/mydash#138 + #140).

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 openregister-specific bits: NL+EN i18n, redocusaurus OAS routes (/api, /api/clientRegister), mermaid theme, custom prism themes, Documentation+API+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> (database-cylinder icon, orange accent, Install/Docs/GitHub CTAs) + a 3-card <WidgetShelf> (schema-driven JSON store, REST + GraphQL, signed audit log per record). Authored as .js not .mdx to avoid the docs-plugin/pages-plugin scan collision.
  • docs/static/CNAMEopenregisters.appopenregister.conduction.nl.
  • .github/workflows/documentation.ymlcname: updated to openregister.conduction.nl.

URL change

Production docs URL moves from https://openregisters.app to https://openregister.conduction.nl (note the singular). Old hardcoded openregisters.app references remain in README.md, docker/QUICKSTART.md, docs/installation.md, docs/Features/registers.md, docs/UseCases/clientRegisters.md, and docs/development/Services/API.md — flagged for a follow-up sweep, not changed in this PR to keep the diff scoped.

Pre-existing MDX-3 issues excluded from build

A handful of dev-notes / session-summary / API-reference markdown files contain raw < and {id} characters that the Docusaurus 3.7 MDX parser rejects (e.g. <= 100 chars, <2026-01-05, GET /api/objects/{id}). These break the build on development already, before this PR. 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. The 12 excluded paths are listed in the config with an explanatory comment.

Test plan

  • Confirm docs/build/index.html and docs/build/nl/index.html render correctly on local preview.
  • Verify the openregister.conduction.nl DNS / GitHub Pages routing once a maintainer merges and the documentation workflow runs from the documentation branch.
  • Spot-check the /api redocusaurus route still loads.
  • Open follow-up issue to clean up MDX-3 escaping in the 12 excluded markdown files.
  • Open follow-up issue to sweep remaining openregisters.app references in README + non-config markdown.

@github-actions

github-actions Bot commented May 7, 2026

Copy link
Copy Markdown
Contributor

Quality Report — ConductionNL/openregister @ 9e24a5b

Check PHP Vue Security License Tests
lint
phpcs
phpmd
psalm
phpstan
phpmetrics
eslint
stylelint
composer ❌ 1/153 denied
npm ✅ 598/598
PHPUnit ⏭️
Newman ⏭️
Playwright ⏭️

❌ Denied composer licenses

Package Version License
dompdf/dompdf v3.1.5 LGPL-2.1

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

Download the full PDF report from the workflow artifacts.

@rubenvdlinde

Copy link
Copy Markdown
Contributor Author

Closing this PR: the migration was force-pushed directly to documentation branch instead. Merging via documentation branch was the agreed path to circumvent the development branch's review-required protection. Workflow fires on documentation push.

@rubenvdlinde rubenvdlinde deleted the feature/conduction-nl-migration branch May 8, 2026 05:05
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