feat: ship a default Docusaurus docs site + journeydoc scaffold#36
Merged
Conversation
…fold
Every new Conduction app currently inherits only a documentation.yml
deploy-workflow stub with no Docusaurus site behind it. This adds the
default so a scaffolded app is born docs-ready:
- docs/ on @conduction/docusaurus-preset 2.6.1 — createConfig/BRAND_THEME,
brand <DetailHero>/<WidgetShelf> landing page, intro.md, custom.css,
sidebars.js, package-lock.json, static/CNAME (app-template.conduction.nl),
static/img/logo.svg.
- journeydoc scaffold (hydra ADR-030) — tutorials/{_category_,user/,admin/}
with two stock stories (user "open the app for the first time" → Dashboard,
admin "manage settings" → Admin Settings), tests/e2e/docs-screenshots.spec.ts
capture suite, and playwright.config.ts with chromium + docs-capture projects.
- .github/workflows/documentation.yml — deploy from `development` to
app-template.conduction.nl (was: `documentation` branch / app-template.app).
- .gitignore — docs/ build artefacts, docs/i18n/nl/, playwright outputs.
- README.md — Screenshots section now points at the journeydoc workflow,
directory-structure block lists docs/ + tests/e2e/ + playwright.config.ts,
and a Documentation section describes the docs-site build + deploy.
Build verified locally (`npm ci --legacy-peer-deps && npm run build`).
rubenvdlinde
requested review from
Rem-Dam,
SudoThijn,
WilcoLouwerse,
bbrands02,
remko48 and
rjzondervan
as code owners
Contributor
Quality Report — ConductionNL/nextcloud-app-template @
|
| 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-12 22:42 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 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.
Every new Conduction app currently inherits only a
documentation.ymldeploy-workflow stub with no Docusaurus site behind it — so each one is "green-field" and needs the docs site stood up by hand (andjourneydoc-init's SKILL.md punts that). This adds the default:docs/on@conduction/docusaurus-preset2.6.1 —createConfig/BRAND_THEME, brand<DetailHero>/<WidgetShelf>landing page (src/pages/index.js),intro.md,custom.css,sidebars.js, regeneratedpackage-lock.json,static/CNAME=app-template.conduction.nl,static/img/logo.svg.tutorials/{_category_,user/,admin/}with two stock tutorial stories mapped to the template's two stock features: user "Open the app for the first time" → Dashboard, admin "Manage settings" → Admin Settings;tests/e2e/docs-screenshots.spec.tscapture spec withUN first-launch+AN admin-settingsstubs;playwright.config.tswithchromium(regression, ignores the capture spec) +docs-captureprojects..github/workflows/documentation.yml— fixed to deploy fromdevelopmentto<slug>.conduction.nl(was: triggers on thedocumentationbranch,cname: app-template.app)..gitignore—docs/build artefacts,docs/i18n/nl/, Playwright outputs.README.md— Screenshots section now points at the journeydoc workflow, the directory-structure block listsdocs/+tests/e2e/+playwright.config.ts, and a Documentation section describes the docs-site build + deploy.Build verified locally (
cd docs && npm ci --legacy-peer-deps && npm run build→[SUCCESS] Generated static files). Remaining build warnings are the preset footer's/privacy//terms//iso/links (pages this site doesn't ship) and Docusaurus's auto-generated category cross-links — same as decidesk's docs site.Leave open for review — this propagates to every future app via the template's
app-templatestring substitution. Follow-up: tightenjourneydoc-init's SKILL.md to say the app already has the scaffold (it becomes purely brown-field — instrument + add-story, no init drop).