The user-facing documentation site for Thesis Management, built with
Docusaurus. It is published to GitHub Pages under
the custom domain https://docs.thesis.aet.cit.tum.de/ (see
static/CNAME).
This site uses pnpm, pinned via the repository's packageManager field.
Enable it once via corepack:
corepack enableNode.js 20 or newer is required.
pnpm install
pnpm startpnpm start boots the Docusaurus dev server (usually at
http://localhost:3000) with hot reload for .mdx, sidebars, config, and
theme files.
pnpm buildThe static output is written to build/. Serve it locally with
pnpm serve if you want to sanity-check the production bundle.
The screenshots referenced from the guides live in
static/img/screenshots/ and are generated by the repo-root
capture-screenshots.sh script (Playwright against a locally running
stack). Do not commit hand-edited screenshots — regenerate them so the UI
stays consistent across the guides.
Deployment is automated: any push to develop that touches
documentation/** or the workflow file triggers
.github/workflows/deploy_docs.yml,
which builds this site with pnpm and publishes the build/ output to the
github-pages environment. Pull requests targeting develop run the same
build as a check but do not deploy.
There is no manual deploy command — do not use pnpm deploy or push to a
gh-pages branch by hand.