Skip to content

chore(docs): consolidate docusaurus/ into docs/ for fleet consistency - #779

Merged
rubenvdlinde merged 1 commit into
developmentfrom
chore/docs-migration
May 18, 2026
Merged

chore(docs): consolidate docusaurus/ into docs/ for fleet consistency#779
rubenvdlinde merged 1 commit into
developmentfrom
chore/docs-migration

Conversation

@rubenvdlinde

Copy link
Copy Markdown
Contributor

Summary

Brings openconnector in line with the rest of the fleet (openregister, opencatalogi, mydash, decidesk, ...) where `docs/` is a self-contained Docusaurus site: config, sidebars, src, static, blog, and content all in one directory.

Supersedes the stale PR #690 which attempted the same migration in March and has been untouched since.

What moved

  • `docusaurus/.gitignore`, `blog/`, `docusaurus.config.js`, `package.json`, `package-lock.json`, `sidebars.js`, `src/`, `static/` -> `docs/` (preserving git history via `git mv`)
  • `docusaurus/README.md` (Docusaurus boilerplate) removed; the existing `docs/README.md` is content the build renders

What changed

File Change
`docs/docusaurus.config.js` `docs.path: '../docs'` -> `docs.path: './'` because the config now lives alongside content. Added `src/`, `static/`, `blog/` to the docs-plugin exclude list so they're not rendered as markdown. Comment updated.
`.github/workflows/documentation.yml` `source-folder: docusaurus` -> `source-folder: docs`
`README.md` Tree-comment simplified to one `docs/` line

Diff stats

  • 69 renames (git mv)
  • 1 deletion (boilerplate README)
  • 2 modifications (workflow + main README)
  • 1 rename+modify (`docusaurus/docusaurus.config.js` -> `docs/docusaurus.config.js` + path/exclude edits)

Out of scope

The `documentation` branch (which the deploy actually fires from) still has the old layout. After this PR merges into `development`, the same migration needs to propagate to `documentation` before the next deploy. That's a separate fast-forward/merge PR.

Test plan

  • CI `build` job in the centralised workflow succeeds on this PR
  • `docs/` contains every file that was previously in `docusaurus/` + the legacy markdown content
  • After merge to documentation branch, `openconnector.conduction.nl` still serves the same pages on the next deploy

Brings openconnector in line with the rest of the fleet (openregister,
opencatalogi, mydash, decidesk, etc.) where docs/ is a self-contained
Docusaurus site: config, sidebars, src, static, blog, and content all
in one directory. Supersedes the stale PR #690 that attempted the same
migration in March.

What moved
- docusaurus/.gitignore, blog/, docusaurus.config.js, package.json,
  package-lock.json, sidebars.js, src/, static/ -> docs/
- docusaurus/README.md (Docusaurus boilerplate) removed; the existing
  docs/README.md is content that the build renders.

What changed
- docs/docusaurus.config.js: docs.path '../docs' -> './', because
  Docusaurus.config.js now lives in the same directory as the
  content. Added src/, static/, blog/ to exclude so the docs plugin
  doesn't try to render them as markdown content. Comment updated to
  document the new fleet-standard layout.
- .github/workflows/documentation.yml: source-folder 'docusaurus' ->
  'docs', so the centralised ConductionNL/.github documentation
  workflow builds the right directory.
- README.md: tree comment simplified to reflect the single docs/ dir.

Verification
- All git mvs detected as renames (69 R + 1 D + 2 M).
- No remaining path references to docusaurus/ except a single
  historical comment in docs/docusaurus.config.js documenting the
  migration.
- preset is already at ^3.5.0 and the postbuild validator is wired
  via the bin command (from the recent fleet sweep).

Next: after this merges to development, the documentation branch
needs the same change before the next openconnector.conduction.nl
deploy. That sync is a separate fast-forward / merge.
@rubenvdlinde
rubenvdlinde merged commit c53f5b1 into development May 18, 2026
8 of 15 checks passed
@rubenvdlinde
rubenvdlinde deleted the chore/docs-migration branch May 18, 2026 19:42
@github-actions

Copy link
Copy Markdown
Contributor

Quality Report — ConductionNL/openconnector @ 2ec928b

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

Quality workflow — 2026-05-18 19:43 UTC

Download the full PDF report from the workflow artifacts.

rubenvdlinde added a commit that referenced this pull request May 19, 2026
The docusaurus -> docs rename landed via PR #779 + sync #780, but the
documentation branch's workflow file still pointed source-folder at
the old 'docusaurus' path. The deploy runner kept hitting
'cd: docusaurus: No such file or directory' and exiting 1.

This is a one-line workflow fix applied directly on documentation
so the deploy retries with the correct path. development was already
correct from #779; this commit brings documentation in line.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant