Upgrade to Docusaurus v3 #1391
Merged
Upgrade to Docusaurus v3 #1391
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
✅ Deploy Preview for snowplow-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Collaborator
|
As checked as many pages as I could. As far as I could see, everything looks and functions the same. I can upgrade the tailwind to v4 now and shade cn to latest but I will do that once it merges to prod. LGTM! |
Contributor
|
Can we just kill runnable code blocks (cc @stanch)? It barely ever gets used |
Collaborator
|
Yes please, I never liked them |
Collaborator
|
There were some nice changes in my previous attempt, like getting rid of ReactMarkdown in tables (because tables can now use variables!): https://github.com/snowplow/documentation/pull/960/files#diff-ee64edc3c02129d4370ec20ae01e210bbb706dda2625c83941ac16734cef679fL27. Could you copy them over? Also, why just 3.0? I think the current is 3.8? I know this will break other things, e.g. the abbreviations plugin. You can check the fix in my PR too. |
- Fixed Buttons on code blocks are overlaying the code instead of above - made the code block use better styles for readability
Collaborator
|
@mscwilson, I have updated the code block component to resolve the issue. Buttons on code blocks are overlaying the code instead of being above it. We had to integrate a whole new component to gain better control, and now we have full control over it. Let me know what you think. |
8:36:27 AM: build: 8:36:27 AM: command: yarn clear && yarn build 8:36:27 AM: commandOrigin: ui 8:36:27 AM: environment: 8:36:27 AM: - NODE_OPTIONS 8:36:27 AM: - PRODUCT_FRUITS 8:36:27 AM: - REVIEW_ID 8:36:27 AM: publish: /opt/build/repo/build 8:36:27 AM: publishOrigin: ui 8:36:27 AM: functionsDirectory: /opt/build/repo/netlify/functions 8:36:27 AM: Build failed due to a user error: Build script returned non-zero exit code: 2 8:36:27 AM: Failing build: Failed to build site 8:36:28 AM: Finished processing build request in 6m8.194s
AH-Avalanche
approved these changes
Sep 19, 2025
AH-Avalanche
approved these changes
Sep 29, 2025
🎨 Typography & Prose Fixes • Fixed Tailwind prose classes being overridden by Docusaurus styles • Corrected CSS variable connections (--ifm-font-color-base now properly uses hsl(var(--muted-foreground))) • Restored proper font sizes and line heights for all prose variants (sm, base, lg, xl, 2xl) • Enhanced MDX content styling with proper color inheritance 🧭 Breadcrumb Component Improvements • Fixed breadcrumb size multiplier from 0.4 to 1.0 (breadcrumbs were 60% too small) • Increased font size from 14px to 16px for better readability• Implemented proper vertical and horizontal alignment for all breadcrumb elements • Fixed home icon alignment to match text elements perfectly • Removed unwanted circular backgrounds and improved spacing 🎯 Menu Navigation Enhancements • Updated menu link styling with consistent border radius controls • Enhanced active state styling with primary color highlights • Improved hover effects and border-left indicators • Refined menu item spacing and alignment 🛠️ Technical Improvements • Resolved Tailwind/Docusaurus CSS specificity conflicts • Enhanced color system integration between design tokens and components • Improved responsive design consistency
Contributor
|
@AH-Avalanche I like the new breadcrumbs! A couple small pieces of feedback:
|
1. Flex-wrap to breadcrumbs when are two many go into their own row 2. Consistent font- weight to 400
Removing the Container class from the layout so that the Tutorials pages align correctly
Pre and Next button were missing from tutorial fixed it so that they appear again. Also enhanced functionality so that clicking the Next button marks the tutorial complete for the user
- Fixed Sidebar to match production - Bug with Level 1 documents out of alignment - Cleaned up some redundant CSS classes that are not needed.
Position the search bar like current production
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.
Upgrade to Docusaurus v3.9
Changes:
:::cautionadmons to:::warningbecause Caution isn't supportedCodeBlock/Contentcomponent{in code blocksmdx-code-blockblocks for some imports - imports can be written directly in the file{version.whatever}now do so directly rather than as aReactMarkdowncomponent