mirror of
https://github.com/clockworklabs/SpacetimeDB.git
synced 2026-05-13 11:17:50 -04:00
Julien Lavocat
afb8c08b98
## Description of Changes - Migrate the documentation site to **Docusaurus**. - Add a **GitHub Action workflow** that runs `pnpm build` on pull requests targeting `master`. This command checks for broken links and images and ensures the site builds correctly. - Add a **GitHub Action workflow** to publish the docs automatically when a merge occurs on the `docs/release` branch. **Important**: The workflows haven't been tested yet due to the fact that they need to be merged first before being able to run. It's a fairly basic workflow I don't expect this to block anyone but anyways I will make another PR with the complete changes when I can actually run it. --- ## API and ABI Breaking Changes No breaking changes for **SpacetimeDB** users. Documentation contributors should experience minimal disruption — content is still written in Markdown. --- ## Expected Complexity Level and Risk **Complexity:** 3/5 **Reasons:** 1. Several adjustments were made to fit Docusaurus conventions: - Replaced our custom `:::server-rust` blocks with [Docusaurus `<Tabs/>` components](https://docusaurus.io/docs/markdown-features/tabs). - Converted “Note” callouts using [admonitions](https://docusaurus.io/docs/markdown-features/admonitions) instead of Markdown blockquotes. - Updated all images (including Unity tutorial ones, which were previously commented out). - Moved images from the DO bucket into the repository at `docs/static/images`. 2. Customized Docusaurus CSS and one component to apply our theme and color palette. --- ## Testing Tested locally. --- ## Review Notes This PR involves many file changes — a full code review is likely not productive. Instead, please focus on verifying that the **documentation content** was migrated correctly: - Review sections you’re familiar with to confirm accuracy. - Ensure formatting, links, and images render as expected. You can follow the updated **README** for instructions on running Docusaurus locally. --------- Signed-off-by: Julien Lavocat <JulienLavocat@users.noreply.github.com> Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com> Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com> Co-authored-by: = <cloutiertyler@gmail.com>
57 lines
1.5 KiB
JSON
57 lines
1.5 KiB
JSON
{
|
|
"name": "docs",
|
|
"version": "0.0.0",
|
|
"private": true,
|
|
"scripts": {
|
|
"docusaurus": "docusaurus",
|
|
"dev": "docusaurus start",
|
|
"build": "docusaurus build",
|
|
"swizzle": "docusaurus swizzle",
|
|
"deploy": "docusaurus deploy",
|
|
"clear": "docusaurus clear",
|
|
"serve": "docusaurus serve",
|
|
"write-translations": "docusaurus write-translations",
|
|
"write-heading-ids": "docusaurus write-heading-ids",
|
|
"typecheck": "tsc"
|
|
},
|
|
"dependencies": {
|
|
"@docusaurus/core": "3.9.1",
|
|
"@docusaurus/preset-classic": "3.9.1",
|
|
"@docusaurus/theme-common": "^3.9.1",
|
|
"@easyops-cn/docusaurus-search-local": "^0.49.2",
|
|
"@fontsource-variable/inter": "^5.2.8",
|
|
"@fontsource-variable/source-code-pro": "^5.2.7",
|
|
"@inkeep/cxkit-docusaurus": "^0.5.98",
|
|
"@inkeep/cxkit-react": "^0.5.101",
|
|
"@inkeep/widgets": "^0.2.292",
|
|
"@mdx-js/react": "^3.0.0",
|
|
"@shikijs/rehype": "^3.3.0",
|
|
"clsx": "^2.0.0",
|
|
"prism-react-renderer": "^2.3.0",
|
|
"react": "^19.0.0",
|
|
"react-dom": "^19.0.0",
|
|
"shiki": "^3.3.0"
|
|
},
|
|
"devDependencies": {
|
|
"@docusaurus/module-type-aliases": "3.9.1",
|
|
"@docusaurus/tsconfig": "3.9.1",
|
|
"@docusaurus/types": "3.9.1",
|
|
"typescript": "~5.6.2"
|
|
},
|
|
"browserslist": {
|
|
"production": [
|
|
">0.5%",
|
|
"not dead",
|
|
"not op_mini all"
|
|
],
|
|
"development": [
|
|
"last 3 chrome version",
|
|
"last 3 firefox version",
|
|
"last 5 safari version"
|
|
]
|
|
},
|
|
"engines": {
|
|
"node": ">=18.0"
|
|
}
|
|
}
|