Skip to content

PR 6: Doku-Website (Astro + Starlight) #45

@Musiker15

Description

@Musiker15

Context

Phase 10 hat die Doku-Website "post-launch" offen gelassen. Aktuell verteilt sich Dokumentation auf README + docs/*.md im Repo. Eine eigene Doku-Website macht Marketing und Onboarding viel besser zugänglich.

Scope

Static-Site-Generator unter docs-site/ (separater Subtree im selben Repo) oder als eigenes Repo mskanban-docs. Empfehlung: Subtree, näher am Code, gleiche Versionierung.

Stack

  • Astro + Starlight — opinionated docs-stack, gut für API + Guides + Marketing-Landings. SSG, kein Runtime nötig.
  • Tailwind (für Custom-Komponenten)
  • Hosted unter docs.mskanban.de oder docs.msk-scripts.de/mskanban via GitHub Pages, deployed über .github/workflows/docs.yml

Initial-Content

  1. Landing — Hero (USP), Feature-Matrix (zieht aus README), Quickstart-Docker
  2. Guides
    • Self-Hosting (Apache + Docker, Variante bare-metal)
    • First Workspace, Erstes Board (Screenshots)
    • 2FA + Recovery-Key (Wichtig!)
    • Backups + Restore
  3. Security Whitepaper — Crypto-Architektur aus CLAUDE.md §3 in Long-Form, mit Diagrammen (mermaid)
  4. API Reference — auto-generated aus docs/api/openapi.yaml via Scalar oder Redocly
  5. ADR-Index — alle 9 ADRs als rendered MD aus docs/architecture/
  6. Release Notes — Mirror von CHANGELOG.md

Files

  • docs-site/ mit Astro-Starlight-Setup
  • .github/workflows/docs.yml — Build + Deploy auf GitHub Pages bei push to main
  • package.json workspace-Setup falls Monorepo

Test plan

  • pnpm --filter docs-site build produziert dist/
  • Lighthouse-Score ≥ 95 (statisch, sollte easy gehen)
  • Alle internen Links 200
  • Mermaid-Diagramme rendern
  • OpenAPI-Renderer zeigt alle 56 Routen + DTOs

Estimate

~4-6 h: Astro-Setup, Theme, Initial-Content (Guides können recycled aus README/docs/), CI-Deploy.

Blocked-by: keine.

Priority: niedriger als Feature-PRs — Marketing-Material, nicht Funktionalität. Aber für Public-Launch-Reach wichtig.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions