docs: fill journeydoc tutorial prose - #76
Merged
Merged
Conversation
… screenshots pending install+seed)
Contributor
Quality Report — ConductionNL/shillinq @
|
| Check | PHP | Vue | Security | License | Tests |
|---|---|---|---|---|---|
| lint | ✅ | ||||
| phpcs | ✅ | ||||
| phpmd | ✅ | ||||
| psalm | ✅ | ||||
| phpstan | ✅ | ||||
| phpmetrics | ✅ | ||||
| eslint | ✅ | ||||
| stylelint | ✅ | ||||
| composer | ✅ | ✅ 100/100 | |||
| npm | ✅ | ✅ 428/428 | |||
| PHPUnit | ✅ | ||||
| Newman | ✅ | ||||
| Playwright | ⏭️ |
Coverage: 0% (0/3 statements)
Quality workflow — 2026-05-13 05:56 UTC
Download the full PDF report from the workflow artifacts.
11 tasks
rubenvdlinde
added a commit
that referenced
this pull request
May 13, 2026
* chore(openspec): add docs-product-pages-conformance change artifacts Audit on 2026-05-13 (consolidated report at apps-extra/AUDIT-product- pages-2026-05-13.md) found shillinq's docs/ partially conformant to the canonical product-pages spec shipped at https://design-system.conduction.nl/preview/product-pages/. This change aligns docs/ structurally + Tier-2 config (folder taxonomy, Redocusaurus mount, nl locale, installation.md, em-dash cleanup) per ADR-030. Tier-3 content authoring is tracked separately: #78 UseCases/ + Integrations/ content #79 Dutch translation pass #80 static/oas/shillinq.json OpenAPI spec #81 remaining {{TODO}} cleanup (mostly resolved by #76) * docs: align with canonical product-pages structure Brings shillinq/docs/ in line with the canonical product-pages layout defined at https://design-system.conduction.nl/preview/product-pages/. Reference implementation: openregister/docs/. Structural (Tier-1) - Rename docs/tutorials/ → docs/user-guide/ (folder + screenshot path). - Move docs/FEATURES.md → docs/Features/index.md (em-dashes fixed). - Move docs/ARCHITECTURE.md → docs/Technical/architecture.md (em-dashes fixed, run-on intro paragraph split into normal prose). - Add empty canonical folders UseCases/ + Integrations/ with draft: true index stubs that point at issue #78. - New docs/installation.md with real Nextcloud install steps (prerequisites, app-store flow, register + chart-of-accounts setup, troubleshooting). - Internal links to ../../ARCHITECTURE.md updated to ../../Technical/architecture.md across 11 tutorial files. - _category_.json labels updated: "Tutorials" → "Guides". Em-dash sweep (REQ-002) - 147 em-dash hits replaced with commas across docs/ (mostly in the user-guide/ files filled in commit #76, plus intro/Architecture/ Features moves). `git grep -E '—' docs/` returns 0. Config (Tier-2) - redocusaurus@^2.0.0 added to docs/package.json (version matches openregister/docs/package.json). - Redocusaurus mounted at /api in docusaurus.config.js, fed by static/oas/shillinq.json. Placeholder OAS shipped so the build does not 404; the real spec lands via issue #80. - Navbar gets an "API Documentation" link to /api, positioned right of "Documentation". - i18n.locales: ['en'] → ['en', 'nl']. No NL markdown ships in this change; the locale dropdown is now available for translators starting work on issue #79. Reversible per ADR-030 escape hatch. Out of scope - No content rewrite of the existing 11 tutorial pages (filled by commit #76 upstream; em-dashes the only edit here). - No NL markdown translation (#79). - No real OpenAPI spec authoring (#80). - No real UseCases/ or Integrations/ content (#78). Build - cd docs && npm install --legacy-peer-deps && npm run build → 0. - Both en and nl locales build successfully. Warnings about /nl/privacy /nl/terms /nl/iso (footer links absent from nl locale) are pre-existing and tracked by #79.
3 tasks
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fills in the journeydoc tutorial prose for the 8 user-track and 3 admin-track pages under
docs/tutorials/, and splices in the new shared journeydoc scaffold from hydra#272 so a future capture run is one command away.Pilot pattern reference: ConductionNL/decidiq#195.
Note: Shillinq is not yet installed in the local dev container, and most of the user-track features the prose describes (invoicing, bills, POs, contracts, banking, VAT, reporting) aren't implemented in the scaffold yet — the live UI is just Dashboard + Settings. The prose describes the intended feature set, grounded in the app's ARCHITECTURE.md / FEATURES.md and the standards it lists (UBL, Peppol, SBR, NLCIUS, RGS, BBV, SEPA, ISO 20022, …) so future capture runs and future implementations have a real target to hit. Screenshot
![]()refs in the markdown will resolve once the relevant pages land in the UI and the capture spec is run. Markdown warns rather than errors on missing images (onBrokenMarkdownImages: 'warn'is the preset default).What's filled
Scaffold splice (from hydra#272)
tests/e2e/global-setup.ts— one-time Nextcloud login →tests/e2e/.auth/admin.jsonstorage stateplaywright.config.ts—globalSetup+use.storageStateon both projectspackage.json—@playwright/test ^1.49.0devDep +test:e2e,test:e2e:docs,test:e2e:installscriptstests/e2e/docs-screenshots.spec.ts— rewritten with the new helpers; test bodies map each tutorial's numbered steps to navigation + screenshot calls (best-effort sketches; most routes don't exist yet)Build verify
cd docs && npm ci --legacy-peer-deps && npm run build→[SUCCESS]. Pre-existing footer-link warnings (/privacy/,/terms/,/iso/) are unrelated.Follow-up once Shillinq is installed + the feature pages land
Until then the markdown image refs warn (broken-image) but the docs build still succeeds.