Skip to content

Repository files navigation

StarDustDocs

The documentation site for StarDust, built with VitePress, covering guides, concepts and reference material in English and Indonesian. Deployed at stardust.konstelasi.co.id/docs.

Develop

npm install
npm run docs:dev

Build

npm run docs:build

VitePress fails the build on a dead internal link, so this doubles as the site's link-integrity check. Deploying is a separate manual step with deploy.sh. On Windows, run bash deploy.sh from Git Bash. From PowerShell or cmd, npm run deploy picks up Windows' WSL bash stub first and fails before the script starts.

Glossary content

docs/reference/glossary.md and docs/id/reference/glossary.md are generated, not hand-written. The canonical content — one entry per term, both locales — lives in a separate repo, StarDustGlossary, which also compiles the same content into StarDustWebsite's glossary catalog. Clone it as a sibling of this repo (the same layout SDDPG uses alongside the engine repo) and run its compiler whenever glossary content changes:

git clone <StarDustGlossary repo URL> ../StarDustGlossary
cd ../StarDustGlossary && npm install && npm run compile

npm run compile (no arguments) writes into ../StarDustDocs and ../StarDustWebsite by default. Page chrome specific to this site — headings, intro copy, the "See also:" label — is generated by the compiler's docs renderer itself, not sourced from canonical content, so it can diverge from the website's tone without drifting the actual definitions.

Run npm run docs:build after regenerating to confirm the pages still build and every internal link resolves, plus npx markdownlint-cli2 "docs/**/*.md" and node scripts/check-consumer-docs.mjs (no ADR citations or numbered build phases).

Releases

Packages

Contributors

Languages