Skip to content
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 26 commits into from
Jan 23, 2025
Merged

feat: revamp iteration one #201

merged 26 commits into from
Jan 23, 2025

Conversation

seiyan-writer
Copy link
Collaborator

@seiyan-writer seiyan-writer commented Jan 13, 2025

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:

  • Incorporates initial landing page
  • Revamps Ecosystem Providers homepage

Additional To-dos

  • Settle on frontend methodology / framework and refactor components (right now there is a mix of different approaches for components and styling)
  • Address general docs feedback

@seiyan-writer seiyan-writer requested a review from a team as a code owner January 13, 2025 07:20
Copy link
Contributor

@cordt-sei cordt-sei left a 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.

pages/build/cosmwasm-general.mdx Outdated Show resolved Hide resolved
pages/build/cosmwasm-general.mdx Outdated Show resolved Hide resolved
pages/build/nft-contract-tutorial.mdx Outdated Show resolved Hide resolved
pages/learn/_meta.json Outdated Show resolved Hide resolved
pages/learn/dev-interoperability.mdx Outdated Show resolved Hide resolved
pages/reference/precompiles/bank.mdx Outdated Show resolved Hide resolved
pages/reference/precompiles/cosmwasm.mdx Outdated Show resolved Hide resolved
pages/reference/precompiles/oracle.mdx Outdated Show resolved Hide resolved
pages/reference/seid/query/dex.md Outdated Show resolved Hide resolved
pages/reference/seid/query/dex/get-order-count.md Outdated Show resolved Hide resolved
@seiyan-writer seiyan-writer requested a review from besated January 16, 2025 00:36
@besated
Copy link
Contributor

besated commented Jan 16, 2025

im seeing a weird behavior with "home" being repeated in the sidebar when i visit different sections:
image

does anyone else have this issue?

Copy link
Contributor

@cordt-sei cordt-sei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good

@seiyan-writer seiyan-writer merged commit c9f0609 into main Jan 23, 2025
1 check passed
@seiyan-writer seiyan-writer deleted the feat/revamp-1 branch January 23, 2025 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants