-
Notifications
You must be signed in to change notification settings - Fork 645
First pass at reorganizing the docs and making them nice #3494
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
cloutiertyler
wants to merge
15
commits into
master
Choose a base branch
from
tyler/docs-reorg
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JulienLavocat
approved these changes
Oct 28, 2025
Contributor
JulienLavocat
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
… tyler/docs-reorg
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of Changes
This PR is the first in a series of PRs which are an effort the reorganize the docs and make it easier for people to get started using SpacetimeDB.
This PR:
kebab-case. This is becausedocIdsare set based on folder and file names, and there is no way to override that within a file (all you can change withid: my-idis the last component of the id. Because we want to be able to access docs in react components we need stable predictable ids._category_.jsonfiles so that the categories do not show up as kebab case in the sidebar.typography.cssfrom the website into this repo for the purpose of keeping them identicalIn a future PR, I intend to:
spacetime dev --template <framework-template>to create a new project for the given frameworkreducerto the templatetableto the templateviewto the templateviewfrom the templateTabGroupfor each language, namely:The idea being that we should explain our platform by concept, not by language. This will also allow us to reuse a lot of prose that is repeated in the different language documents.
API and ABI breaking changes
None
Expected complexity level and risk
1
Testing