docs: add setup instructions

Author: 3w36zj6

website/typst-docs-web/README.md

@@ -6,8 +6,64 @@
 
 A generator that builds a website from a documentation JSON file generated by typst-docs.
 
+## Required toolchains
+
+- [Node.js](https://nodejs.org/)
+- [Bun](https://bun.sh/)
+
+Using [mise](https://mise.jdx.dev/) is recommended, as it enables central management of all the toolchains required for both the SSG and the upstream typst-docs.
+
+```toml
+# mise.toml
+[tools]
+rust = "1.83.0" # set required version for typst-docs
+node = "22.11.0"
+bun = "1.2.21"
+```
+
+## Setup
+
+The typst-docs CLI outputs the static files required for building the documentation. Place the JSON file and assets generated by typst-docs in the `/public/` directory. In most use cases, symbolic links are convenient.
+
+```sh
+# Run in the root directory of typst/typst repository
+cargo run --package typst-docs -- --assets-dir assets --out-file docs.json --base /docs/
+```
+
+```plaintext
+public
+├── assets ⇒ /path/to/typst/assets
+└── docs.json ⇒ /path/to/typst/docs.json
+```
+
+Create `/public/metadata.json` and describe the metadata for the documentation website. For details on each property, refer to the JSON schema. For example:
+
+```json
+{
+  "$schema": "/path/to/typst-docs-web/metadata.schema.json",
+  "language": "ja-JP",
+  "version": "0.13.1",
+  "typstOfficialUrl": "https://typst.app",
+  "typstOfficialDocsUrl": "https://typst.app/docs/",
+  "githubOrganizationUrl": "https://github.com/typst-jp",
+  "githubRepositoryUrl": "https://github.com/typst-jp/docs",
+  "discordServerUrl": "https://discord.gg/9xF7k4aAuH",
+  "originUrl": "https://typst-jp.github.io/",
+  "basePath": "/docs/",
+  "displayTranslationStatus": true
+}
+```
+
+`/public/translation-status.json` is used to manage the translation progress and the classification of original content. This file is automatically updated when running the SSG, so manual editing is not necessary.
+
 ## Commands
 
+After installing dependencies with Bun, the following commands are available:
+
+```sh
+bun install --frozen-lockfile
+```
+
 ### Develop
 
 > [!NOTE]