This repository was archived by the owner on May 29, 2026. It is now read-only.
feat(docs): adopt @conduction/docusaurus-preset + move to softwarecatalog.conduction.nl#216
Merged
Merged
Conversation
…alog.conduction.nl Adopts the shared @conduction/docusaurus-preset@^1.4.3 for the SoftwareCatalog docs site and moves it to softwarecatalog.conduction.nl. Mirrors the openregister docs migration in ConductionNL/openregister#1444 and the mydash precedent. 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 softwarecatalog-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> (catalog-grid icon, orange accent, Install/Docs/GitHub CTAs) + a 3-card <WidgetShelf> (Renewals due, Inventory snapshot, Discovery deltas). Authored as .js not .mdx to avoid the docs-plugin/pages- plugin scan collision. - docs/static/CNAME — softwarecatalog.app -> softwarecatalog.conduction.nl. - .github/workflows/documentation.yml — cname: updated to softwarecatalog.conduction.nl. URL change Production docs URL moves from https://softwarecatalog.app to https://softwarecatalog.conduction.nl. No old hardcoded softwarecatalog.app references in src/; one mention in docs/CONTACTPERSOON_USER_DETAILS.md is a code path (softwarecatalog/appinfo/routes.php), not the domain.
Contributor
Quality Report — ConductionNL/softwarecatalog @
|
| Check | PHP | Vue | Security | License | Tests |
|---|---|---|---|---|---|
| lint | ✅ | ||||
| phpcs | ❌ | ||||
| phpmd | ✅ | ||||
| psalm | ✅ | ||||
| phpstan | ✅ | ||||
| phpmetrics | ✅ | ||||
| eslint | ❌ | ||||
| stylelint | ❌ | ||||
| composer | ✅ | ✅ 120/120 | |||
| 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 SoftwareCatalog docs site and moves it tosoftwarecatalog.conduction.nl. Mirrors the openregister docs migration (canonical example: ConductionNL/openregister#1444) and the mydash precedent.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 softwarecatalog-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.json— adds@conduction/docusaurus-preset@^1.4.3.docs/src/pages/index.js— replaces the homepage with<DetailHero>(catalog-grid icon, orange accent, Install / Docs / GitHub CTAs) + a 3-card<WidgetShelf>(Renewals due, Inventory snapshot, Discovery deltas). Authored as.jsnot.mdxto avoid the docs-plugin/pages-plugin scan collision. Tagline + 3-card composition cited from the connext detail page atdesign-system/sites/www/src/pages/apps/softwarecatalog.mdx.docs/static/CNAME—softwarecatalog.app->softwarecatalog.conduction.nl..github/workflows/documentation.yml—cname:updated tosoftwarecatalog.conduction.nl.URL change
Production docs URL moves from
https://softwarecatalog.apptohttps://softwarecatalog.conduction.nl. No old hardcodedsoftwarecatalog.appreferences indocs/src/; the only mention of "softwarecatalog.app" left indocs/is a code path (softwarecatalog/appinfo/routes.php) insidedocs/CONTACTPERSOON_USER_DETAILS.md, not the domain.Build
npm run buildsucceeds locally. Bothbuild/index.htmlandbuild/nl/index.htmlare generated. Broken-link warnings remain for/privacy/,/terms/,/iso/on the NL locale (the brand preset MDXPage swizzle does not yet ship NL versions of those pages); the build still completes.i18n
Pre-existing MDX excludes
**/node_modules/**andsrc/**. Unlike openregister, the softwarecatalog docs do not contain raw</{id}characters that the MDX 3 parser rejects, so no per-file excludes were needed.Test plan
docs/build/index.htmlanddocs/build/nl/index.htmlrender correctly on local preview.softwarecatalog.conduction.nlDNS / GitHub Pages routing once a maintainer merges and the documentation workflow runs from thedocumentationbranch./privacy///terms///iso/need NL surfaces in the brand preset.Do not admin-merge — leave open for green CI before merge.