search

zksync-sdk / sdk-docs

Documentation for 3rd-party SDKs that integrate with zkSync
https://docs.zksync.io/sdk
Apache License 2.0
1 stars 5 forks source link

[Feature]: Dropdown select for SDKs in sidebar navigation #43

Open itsacoyote opened 3 months ago

itsacoyote commented 3 months ago

Description

  1. SDK Selection:
    • Users can see a list of available SDKs (JavaScript, Python, Go, Rust, Java, Swift).
    • Users select the SDK they are interested in, which then expands to show the sections specific to that SDK.
  2. Section List:
    • Once an SDK is selected, a list of sections (like Introduction, Getting Started, Usage, etc.) appears.
    • Users can click on any section to view its content in the right pane.
image (2)

Rationale

  1. Ease of Navigation:
    • Users can easily switch between different SDKs and sections without scrolling through long pages.
    • The structure helps users find what they are looking for quickly.
  2. Consistency:
    • Each SDK has the same set of sections, so users know where to find specific types of information regardless of the SDK they are using.
  3. Focus:
    • By separating navigation from content, users can focus on reading the information they need without distraction.
    • It reduces the clutter on the screen, making the documentation cleaner and more user-friendly.
  4. Scalability:
    • This layout can easily accommodate more SDKs or additional sections in the future without becoming unwieldy.
    • It maintains a consistent user experience as the documentation grows.

Code of Conduct