Skip to content

docs: align with canonical product-pages structure - #443

Merged
rubenvdlinde merged 2 commits into
developmentfrom
feature/docs-product-pages-conformance
May 13, 2026
Merged

docs: align with canonical product-pages structure#443
rubenvdlinde merged 2 commits into
developmentfrom
feature/docs-product-pages-conformance

Conversation

@rubenvdlinde

Copy link
Copy Markdown
Contributor

Summary

Aligns procest docs/ with the canonical product-pages structure audited on 2026-05-13, following the pattern of shillinq#83 (live at https://shillinq.conduction.nl/).

Pre-flight adjustments: preset bump dropped (already in #433), tutorial content fills dropped (already in #437).

Tier-1 deliverables (structural)

  • docs/features/ renamed to docs/Features/ (44 files, history preserved via git mv)
  • docs/tutorials/ renamed to docs/user-guide/ (11 MD files + screenshots)
  • 6 root MDs moved to docs/Technical/: architecture, design-decisions, development-guide, zgw-spec, government-compliance, market-analysis
  • docs/README.md -> docs/index.md with id/title/sidebar_position frontmatter
  • category.json for Features (pos 3), UseCases (pos 4), Integrations (pos 5), Technical (pos 6)
  • user-guide/category.json label updated from Tutorials to User Guide

Tier-2 deliverables (new content + config)

Acceptance criteria

Check Result
git grep em-dash gate 0 matches
npm run build en PASS
npm run build nl PASS (redocusaurus 2.5.0, Docusaurus 3.9.2)

Tier-3 follow-ups

Generated with Claude Code

Audit on 2026-05-13 (consolidated report at apps-extra/AUDIT-product-
pages-2026-05-13.md) found procest's docs/ partially conformant to
the canonical product-pages spec shipped at
https://design-system.conduction.nl/preview/product-pages/.

Tier-3 follow-ups tracked separately:
  #440 UseCases/ + Integrations/ content
  #441 Dutch translation pass
  #442 static/oas/procest.json OpenAPI spec

Pre-flight: preset bump and tutorial content fills already landed
upstream (#433, #437) — scope adjusted accordingly.
Structural changes:
- docs/features/ -> docs/Features/ (canonical casing)
- docs/tutorials/ -> docs/user-guide/ (canonical name)
- 6 root MDs moved to docs/Technical/ (architecture, design-decisions,
  development-guide, zgw-spec, government-compliance, market-analysis)
- docs/README.md -> docs/index.md with id/title/sidebar_position frontmatter
- New docs/installation.md (prerequisites, app-store install, ZGW config,
  troubleshooting)
- New docs/UseCases/ + docs/Integrations/ draft stubs (content in #440)
- _category_.json for Features (pos 3), UseCases (pos 4), Integrations
  (pos 5), Technical (pos 6); user-guide label updated to "User Guide"

Config changes:
- redocusaurus preset added, static/oas/procest.json placeholder OAS shim,
  /api/ route; "API Documentation" navbar item
- i18n.locales expanded to ['en', 'nl'] with localeConfigs for both
- Internal links updated: ../../features/ -> ../../Features/ in user-guide/

Em-dash sweep (357 -> 0):
- All ` — ` replaced with `: ` across 29 MD files (Features/, Technical/,
  user-guide/); YAML frontmatter descriptions with colons quoted
- Gate verified: git grep -E '—' docs/ returns 0

Build: PASS (en + nl, redocusaurus 2.5.0, Docusaurus 3.9.2)
@rubenvdlinde
rubenvdlinde requested a review from Rem-Dam as a code owner May 13, 2026 08:36
@rubenvdlinde rubenvdlinde added the documentation Improvements or additions to documentation label May 13, 2026
@rubenvdlinde
rubenvdlinde merged commit f86b16f into development May 13, 2026
35 of 36 checks passed
@rubenvdlinde
rubenvdlinde deleted the feature/docs-product-pages-conformance branch May 13, 2026 08:36
@github-actions

Copy link
Copy Markdown
Contributor

Quality Report — ConductionNL/procest @ e2f3ecb

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

Coverage: 0% (0/81 statements)

Spec coverage: 7% (30 tests / 456 specs)


Quality workflow — 2026-05-13 08:51 UTC

Download the full PDF report from the workflow artifacts.

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant