-
Notifications
You must be signed in to change notification settings - Fork 616
Docusaurus migration #3343
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
base: master
Are you sure you want to change the base?
Docusaurus migration #3343
Conversation
fbd26f2
to
aa7cca6
Compare
ae90c28
to
2a7bf53
Compare
46c21ab
to
f590ae0
Compare
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.
One question on this one so far, otherwise the rest of the edits look good to me
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.
Reminder that I still needed to run this command in order to get the docs rendering:
pnpm add @docusaurus/theme-common
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.
I've reviewed a majority of the documentation and I think it looks good. There are just 2 issues to fix here I think:
- Fix the issue with having to manually install @docusaurus/theme-common
- Fix the code formatting issues in the Unity tutorial
besides that I think this is ready to go. Let me know when you want me to take another look 👍
0892495
to
9f04566
Compare
|
baf85ff
to
b4d4691
Compare
Looks great! All the Unreal stuff is complete. |
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.
Few more formatting issues here
b4d4691
to
42faabf
Compare
42faabf
to
8050d6b
Compare
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.
I committed some small formatting issues that I found. Other than that I don't have any issues here with the docs. The only remaining issue was the error when I tried to npm install
. Thanks Julien 👍
The error for reference was:
boppy@geralt MINGW64 ~/clockwork/SpacetimeDB/docs (docusaurus-migration)
$ pnpm install
Scope: all 5 workspace projects
.. | WARN Broken lockfile: no entry for 'tsup@8.5.0(jiti@2.5.1)(postcss@8.5.6)(tsx@4.20.4)(typescript@5.9.3)' in pnpm-lock.yaml
ERR_PNPM_LOCKFILE_MISSING_DEPENDENCY The lockfile is broken! Resolution step will be performed to fix it.
../crates/bindings-typescript | WARN Could not find preferred package tsup@8.5.0(jiti@2.5.1)(postcss@8.5.6)(tsx@4.20.4)(typescript@5.9.3) in lockfile
WARN 2 deprecated subdependencies found: node-domexception@1.0.0, source-map@0.8.0-beta.0
.. | +12 -11 +-
.. | Progress: resolved 1619, reused 1554, downloaded 6, added 12, done
WARN Issues with peer dependencies found
docs
└─┬ @types/react-dom 18.3.7
└── ✕ unmet peer @types/react@^18.0.0: found 19.1.13
Done in 6.2s
Description of Changes
pnpm build
on pull requests targetingmaster
.This command checks for broken links and images and ensures the site builds correctly.
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:
Several adjustments were made to fit Docusaurus conventions:
:::server-rust
blocks with Docusaurus<Tabs/>
components.docs/static/images
.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:
You can follow the updated README for instructions on running Docusaurus locally.