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

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

Open
1 task done
itsacoyote opened this issue Jun 11, 2024 · 0 comments
Open
1 task done

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

itsacoyote opened this issue Jun 11, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@itsacoyote
Copy link
Contributor

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

  • I agree to follow this project's Code of Conduct
@itsacoyote itsacoyote added the enhancement New feature or request label Jun 11, 2024
@itsacoyote itsacoyote self-assigned this Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant