mirror of
https://github.com/clockworklabs/SpacetimeDB.git
synced 2026-08-09 02:30:42 -04:00
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 <[email protected]> Co-authored-by: John Detter <[email protected]> Co-authored-by: Tyler Cloutier <[email protected]> Co-authored-by: = <[email protected]>
12 lines
1.8 KiB
XML
12 lines
1.8 KiB
XML
<svg width="1024" height="1024" viewBox="0 0 1024 1024" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
<g clip-path="url(#clip0_1541_82)">
|
|
<path fill-rule="evenodd" clip-rule="evenodd" d="M815.061 493.786C808.444 339.527 837.316 250.412 981.333 85.3333L746.753 322.394L714.442 355.046C702.412 367.204 701.503 386.269 710.088 401.062C760.641 488.161 748.942 601.98 674.991 676.711C601.224 751.258 488.97 763.207 402.865 712.558C387.89 703.749 368.467 704.678 356.247 717.027L324.379 749.231L324.577 749.397L239.863 835.628C303.826 798.189 402.6 808.931 462.184 815.411C478.687 817.206 492.184 818.674 501.103 818.701C582.725 822.758 665.675 793.289 728.012 730.293C792.164 665.463 821.18 578.572 815.061 493.786ZM522.898 205.299C531.816 205.326 545.313 206.794 561.816 208.588C621.401 215.069 720.174 225.811 784.137 188.372L699.423 274.603L699.621 274.769L667.754 306.973C655.534 319.322 636.11 320.251 621.135 311.442C535.03 260.793 422.776 272.742 349.009 347.288C275.059 422.02 263.36 535.839 313.912 622.938C322.498 637.731 321.589 656.796 309.558 668.954L277.248 701.606L42.6667 938.667C186.684 773.588 215.556 684.473 208.939 530.214C202.82 445.428 231.836 358.537 295.988 293.707C358.325 230.711 441.275 201.242 522.898 205.299ZM692.514 511.999C692.514 612.748 611.695 694.421 512 694.421C412.305 694.421 331.486 612.748 331.486 511.999C331.486 411.25 412.305 329.577 512 329.577C611.695 329.577 692.514 411.25 692.514 511.999ZM706.4 511.999C706.4 620.498 619.364 708.454 512 708.454C404.636 708.454 317.6 620.498 317.6 511.999C317.6 403.5 404.636 315.545 512 315.545C619.364 315.545 706.4 403.5 706.4 511.999Z" fill="#F4F6FC"/>
|
|
<circle cx="512" cy="512" r="188" stroke="#F4F6FC" stroke-width="8"/>
|
|
</g>
|
|
<defs>
|
|
<clipPath id="clip0_1541_82">
|
|
<rect width="1024" height="1024" fill="white"/>
|
|
</clipPath>
|
|
</defs>
|
|
</svg>
|
