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
Merged
Conversation
Contributor
Quality Report — ConductionNL/openregister @
|
| 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.
This was referenced May 7, 2026
Contributor
Author
|
Closing this PR: the migration was force-pushed directly to |
ba8968d to
2d74621
Compare
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 OpenRegister docs site and moves it toopenregister.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 callcreateConfig()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 viabaseFooterLinks().filter(...).minigames: falseto 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.jsnot.mdxto avoid the docs-plugin/pages-plugin scan collision.docs/static/CNAME—openregisters.app→openregister.conduction.nl..github/workflows/documentation.yml—cname:updated toopenregister.conduction.nl.URL change
Production docs URL moves from
https://openregisters.apptohttps://openregister.conduction.nl(note the singular). Old hardcodedopenregisters.appreferences remain inREADME.md,docker/QUICKSTART.md,docs/installation.md,docs/Features/registers.md,docs/UseCases/clientRegisters.md, anddocs/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 ondevelopmentalready, before this PR. Rather than expanding scope, they are added todocs.excludein 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
docs/build/index.htmlanddocs/build/nl/index.htmlrender correctly on local preview.documentationbranch./apiredocusaurus route still loads.openregisters.appreferences in README + non-config markdown.