feat: new docs structure (1/n)

[seiyan-writer]

What is the purpose of the change?

This change introduces the first iteration of the new docs structure.

Describe the changes to the documentation

Summary:

Screen.Recording.2024-09-30.at.10.37.56.PM.mov

Preview available here.

This update introduces a top bar navigation system to organize and segment the docs more effectively. 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: Getting Started*, User Guides, Learning, Building, Operating Nodes, and Reference.

The top bar structure is the first step in a larger revamp of the Sei docs. The next phases will involve refining the content within each section, gradually restructuring and adding new material as needed. The sidebar will aim to maintain a maximum depth of two levels to ensure ease of navigation and prevent users from becoming overwhelmed by overly nested structures.

The index page serves as the homepage for the docs, acting as a calibration point with use cases and user stories that help introduce Sei. Cards can be used to guide users toward relevant content based on what is trying to be accomplished.

The learning paths serve as guided entry points throughout the docs, offering structured progression for different levels of expertise. Alongside these paths, environment-specific indexes for EVM and Cosmos are provided. These paths can reside in the sidebar consistently, with customized styling to ensure they complement, rather than overpower, the other sub-doc sections.

The indexes leverage a new DocsCard component, inspired by the existing AppCard. This component is flexible and can be iterated on or further customized for different use cases and visual styles.

Section-Specific Descriptions:

Getting Started:

Introductory material and onboarding resources for new developers.

Note

The Getting Started section helps developers accomplish tasks on Sei without needing deep knowledge of the platform upfront. It assumes they have some blockchain exposure or experience and are more interested in practical applications than in Sei's underlying architecture.

The emphasis is on guiding users through tutorials or guides to get them onboarded with Sei-specific concepts as they go. This section would also cross-references other parts of the docs.

User Guides:

User-facing material and resources.

Note

The User Guides section is designed to guide users how to perform fundamental tasks on Sei, such as setting up wallets, managing accounts, and interacting with the network. This section provides user-friendly guides that make it easier for users to navigate and engage with the Sei ecosystem.

Learning:

Explainers for understanding the key concepts and mechanics of the Sei network.

Note

The Learning section offers users an opportunity to dive deeper into how Sei functions (without labeling concepts as "advanced"). It’s ideal for those looking to explore the network’s mechanics and gain a better understanding after using Getting Started, or for users who prefer to begin by learning the concepts from the outset. As the docs evolves, this section will continue to expand and align with the new proposed sidebar.

Building:

Resources for developers to set up, build, and deploy applications on Sei, from environment setup to smart contract development and ecosystem tools.

Note

The Building section provides developers with a comprehensive set of resources for end-to-end Sei development. It covers a variety of smart contract environments like CosmWasm and EVM, along with support for NFT Contracts, Pointer Contracts, and other key functionalities like the Token Factory and Multi-Sig Accounts.

Developers will also find resources for integrating assets, exploring the IBC Protocol for cross-chain connectivity, and best practices for using Ledger devices. This section includes tools and resources specific to the Sei ecosystem, ensuring developers have everything they need for successful decentralized application development across multiple environments.

Operating Nodes:

Node setup, configuration, and the go-to place for validators.

Note

Operating Nodes is dedicated to largely to validators who manage and maintain nodes on the Sei network. This section includes detailed guides on node setup, configuration, and validator best practices. Validators should be able to find everything they need here to ensure their nodes are correctly configured and optimized for network participation.

Reference:

The official technical reference for CLI, APIs, and more.

Note

The Reference section provides the official technical references, including API references, CLI usage, and other essential tools for developers and node operators. This section is designed to be a lookup resource for specific commands, endpoints, and technical specifications.