-
Notifications
You must be signed in to change notification settings - Fork 1.3k
feat: Release notes for new docs #9091
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: main
Are you sure you want to change the base?
Conversation
|
Build successful! 🎉 |
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
|
Build successful! 🎉 |
|
Build successful! 🎉 |
|
Build successful! 🎉 |
|
Build successful! 🎉 |
|
Build successful! 🎉 |
|
I think the overall structure looks good. Did we ever discuss if we want the contents of the S2 release notes to be structured like our old docs, or if we plan to leave it the same as what we had in storybook? As for the RAC release notes, do we need to update the release notes to filter out any V3 changes (or did you already do that?) |
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.
It might be nice to have Breadcrumbs at the top of the release pages with a link back to the Releases page.
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.
we'll need to fix the links somehow
|
are we only including releases back to the start of RAC? what about ones before that? |
|
Build successful! 🎉 |
|
Build successful! 🎉 |
My thoughts on this right now. Anything before that will likely be filled with broken links etc, they should be preserved for the future though. I propose either keeping them in unused mdx files in our repo, or copying their contents to the appropriate GitHub release tag with a disclaimer that the urls may not link to the correct place or may just be broken. |
# Conflicts: # packages/dev/s2-docs/src/CodeBlock.tsx # packages/dev/s2-docs/src/Layout.tsx
|
Build successful! 🎉 |
I've done a light sweep, if you see anything obvious, feel free to point it out |
|
Build successful! 🎉 |
|
Build successful! 🎉 |
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.
will go through the rest tomorrow
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.
the spacing in between the bullets is inconsistent. some sections they are spaced more tightly than others
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.
do you have an example?
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.
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.
it would be nice if there was a chevron left at the top so that you can easily get back to the release page rather than having to click on it in the side nav
# Conflicts: # packages/dev/s2-docs/src/Code.tsx # packages/dev/s2-docs/src/CodeBlock.tsx
|
Build successful! 🎉 |
|
Build successful! 🎉 |
|
Build successful! 🎉 |
|
Build successful! 🎉 |

Closes
Starting point for release notes
✅ Pull Request Checklist:
📝 Test Instructions:
🧢 Your Project: