-
Notifications
You must be signed in to change notification settings - Fork 639
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
42faabf
to
8050d6b
Compare
Signed-off-by: Julien Lavocat <[email protected]>
# Description of Changes This PR fixes small styling issues with the [docusaurus migration PR](#3343). Mainly it: 1. Ensures that we only have one single reference to any particular color definition (`#fefaef`) so that if we change the style guide (see figma) we can easily update the colors. 2. It removes references to any colors that are not specified in the style guide 3. It updates font sizes and styling to be one of the pre-defined styles specified in the style guide 4. Adds the precise fonts specified in the style guide and ensures that they are preloaded 5. Makes very minor docs changes 6. Implements the tab highlighting for the selected tab (and on hover) <img width="578" height="372" alt="image" src="https://github.com/user-attachments/assets/b1d3962b-220b-4df0-aa65-c8d03b2c613c" /> After the docusaurus PR merges I would like to do a larger update to some of the docs content, but I'm keeping that separate. # API and ABI breaking changes None # Expected complexity level and risk 1 # 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] Tested styles locally - [x] Built and ran pnpm run sever to verify that fonts were being correctly preloaded
bd2fb2d
to
9f61000
Compare
9f61000
to
e1f8fa8
Compare
e1f8fa8
to
ee7ce29
Compare
7a623bb
to
48ad0de
Compare
48ad0de
to
ef425ca
Compare
94815f9
to
67aad43
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.
This looks good enough to me now. I think we still need to do some updates on the styling, but I think we'll wait to do a full styling pass from Randy
Signed-off-by: Julien Lavocat <[email protected]>
Signed-off-by: Julien Lavocat <[email protected]>
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.