generated from shuding/nextra-docs-template
-
Notifications
You must be signed in to change notification settings - Fork 38
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
feat: revamp iteration one #201
Merged
Merged
Conversation
This file contains 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
cordt-sei
requested changes
Jan 13, 2025
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.
Nice work! Also, you must have the same keyboard switches as me.
cordt-sei
approved these changes
Jan 14, 2025
besated
reviewed
Jan 14, 2025
besated
approved these changes
Jan 23, 2025
cordt-sei
approved these changes
Jan 23, 2025
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.
looks good
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.
What is the purpose of the change?
Introduces the first iteration of the docs revamp.
Describe the changes to the documentation
This update introduces a top bar navigation system to organize and segment the docs more effectively with some broad improvements to the docs themselves, along with a landing page. The top bar helps improve navigation and access to key docs categories. This implementation builds on earlier sidebar ideation and categorization efforts, with the goal of simplifying navigation and enhancing user experience.
The proposed top bar categories (for today) are: "Learn", "Build", "Operate", "Reference", and "Providers" (which is intentionally kept top level for visibility). Different categories were considered, as seen in the associated PRs.
The sub docs are the first step in a larger revamp of the Sei docs. There are different components that will also be introduced in separate updates as fast follows to this initial PR, meant to introduce more a more dynamic and targeted learning experience, along with updates to a various individual docs.
The next phases will involve refining the content within each section, gradually restructuring and adding new material as needed.
It captures the settled on updates (and experimentation) in:
NEW:
Additional To-dos