[jwindhager]

References and relevant issues

Moves the Docusaurus docs app out of TissUUmaps/TissUUmaps (apps/docs) into this repository, as the start of the TissUUmaps website. A follow-up TissUUmaps PR will publish the released docs to releases/ here.

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Improvement (non-breaking change which modifies an existing feature)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Other

List of changes made

• Docusaurus site scaffolded with create-docusaurus (classic, TypeScript), with the config, landing page and assets of apps/docs. No blog.
• Docs are versioned by MAJOR.MINOR line. On every release, TissUUmaps pushes releases/<line>/ (release.json with the released version, and docs/ incl. the typedoc API markdown).
• scripts/prepare.ts selects the lines to show (every stable line, plus prerelease lines ahead of the latest stable one), creates their Docusaurus versions with docusaurus docs:version, and downloads their apps from the TissUUmaps releases into app/<line>/ (with the Matomo snippet).
• Local preview of a TissUUmaps checkout's docs as "Next" via TISSUUMAPS_DOCS=../TissUUmaps/docs pnpm run start.
• Workflows: deploy.yaml builds and deploys to GitHub Pages on every push to main; ci.yaml checks PRs (format, lint, typecheck, tests, and a build once releases exist).
• Tooling aligned with TissUUmaps: ESLint, husky + lint-staged, strict tsconfig, prettier; MIT license.

Screenshot of the fix

Use of AI

Claude Code was used for development.

Testing

• Requires new configuration settings: Pages enabled with "GitHub Actions" as source. The deploy fails ("holds no releases") until the first TissUUmaps release has pushed its docs.
• Instructions on how to test: pnpm run fmt:check, lint, typecheck and test pass. Locally:
  • Generate the API docs in a TissUUmaps checkout, then TISSUUMAPS_DOCS=../TissUUmaps/docs pnpm run start.
  • Add a releases/<line>/ (e.g. a copy of those docs with { "version": "4.0.0-beta.2" }), then pnpm run prepare:site && pnpm run build && pnpm run serve.

Further comments

• Served at tissuumaps.github.io/website/ until this repository replaces tissuumaps.github.io; only the default baseUrl reflects that. Links in this repository (README, projectName) and in TissUUmaps already assume the final URL.