Tyler Cloutier
d78517fd9a
# Description of Changes This PR does several small things: 1. It removes the explicit `h1` tags on every page, and either uses the side bar title directly, or puts it in the frontmatter 2. It merges what are currently called quickstarts into a single Chat App Tutorial 3. It creates new quickstarts which just use `spacetime dev --template` to get you up and running quickly 4. It adds a "The Zen of SpacetimeDB" page much like the Zen of Python which goes over the 5 key principles of SpacetimeDB 5. It reorders all Tabs groups so that the ordering is `TypeScript`, `C#`, `Rust`, `Unreal`, `C++`, `Blueprints` (order of decreasing popularity). 6. It improves the sidebar navigation by having categories act as overview pages, and also fixes the breadcrumbs 7. It fixes various small typos and issues 8. Closes #3610 and adds cursor rules files generally 9. It fixes general styling on the docs page by bring it inline with the UI design: Old: <img width="1678" height="958" alt="image" src="https://github.com/user-attachments/assets/f36efee6-b81a-4463-a179-da68b3a7152e" /> New: <img width="1678" height="957" alt="image" src="https://github.com/user-attachments/assets/f430f77d-0663-47f2-9727-45cbfe10e4c7" /> https://github.com/user-attachments/assets/adc5a78a-ada8-45b5-8078-a45cb81477a3 # API and ABI breaking changes This PR does NOT change any old links. It does add new pages though. # Expected complexity level and risk 3 - it's a large change. I manually tested the TypeScript Chat App Tutorial but I have not gone through the Rust and C# quickstarts. However, we have testing on the quickstarts and this is text only so can be carefully reviewed. # Testing <!-- Describe any testing you've done, and any testing you'd like your reviewers to do, so that you're confident that all the changes work as expected! --> - [x] Ran through each step of the Chat App TypeScript tutorial to ensure it is working - [x] Ran and tested the styles and the functionality of the side bar --------- Signed-off-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com> Co-authored-by: spacetimedb-bot <spacetimedb-bot@users.noreply.github.com> Co-authored-by: clockworklabs-bot <clockworklabs-bot@users.noreply.github.com> Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com> Co-authored-by: clockwork-labs-bot <clockwork-labs-bot@users.noreply.github.com>
SpacetimeDB Documentation
This repository contains the markdown files which are used to display documentation on our website. This documentation is built using Docusaurus.
Making Edits
To make changes to our docs, you can open a pull request in this repository. You can typically edit the files directly using the GitHub web interface, but you can also clone our repository and make your edits locally.
Instructions
- Fork our repository
- Clone your fork:
git clone ssh://git@github.com/<username>/SpacetimeDB
cd SpacetimeDB/docs
- Make your edits to the docs that you want to make + test them locally (See Testing Locally)
- Commit your changes:
git add .
git commit -m "A specific description of the changes I made and why"
- Push your changes to your fork as a branch
git checkout -b a-branch-name-that-describes-my-change
git push -u origin a-branch-name-that-describes-my-change
- Go to our GitHub and open a PR that references your branch in your fork on your GitHub
CLI Reference Section
To regenerate the CLI reference section, run pnpm generate-cli-docs.
Docusaurus Documentation
For more information on how to use Docusaurus, see the Docusaurus documentation.
Testing Locally
Installation
- Make sure you have Node.js installed (version 22 or higher is recommended).
- Clone the repository and navigate to the
docsdirectory. - Install the dependencies:
pnpm install - Run the development server:
pnpm dev, which will start a local server and open a browser window. All changes you make to the markdown files will be reflected live in the browser.
Adding new pages
All of our directory and file names are prefixed with a five-digit number which determines how they're sorted. We started with the hundreds place as the smallest significant digit, to allow using the tens and ones places to add new pages between. When adding a new page in between two existing pages, choose a number which:
- Doesn't use any more significant figures than it needs to.
- Is approximately halfway between the previous and next page.
For example, if you want to add a new page between 00300-foo and 00400-bar, name it 00350-baz. To add a new page between 00350-baz and 00400-bar, prefer 00370-quux or 00380-quux, rather than 00375-quux, to avoid populating the ones place.
To add a new page after all previous pages, use the smallest multiple of 100 larger than all other pages. For example, if the highest-numbered existing page is 01350-abc, create 01400-def.
License
This documentation repository is licensed under Apache 2.0. See LICENSE.txt for more details