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

Improvements to Documentation for Better User Experience #2491

Open
printfer opened this issue Jan 20, 2025 · 0 comments
Open

Improvements to Documentation for Better User Experience #2491

printfer opened this issue Jan 20, 2025 · 0 comments

Comments

@printfer
Copy link
Contributor

Hi @nekohasekai, thank you for your hard work on this project—it's greatly appreciated! I have a proposal to improve the documentation to enhance user experience. These changes are aimed at making the structure clearer, more beginner-friendly, and easier to navigate. Below are the proposed changes in detail:

Proposed Changes:

  1. Merge "Installation" and "Graphical Clients" Pages:

    • Combine these two pages into one page called "Installation".
    • The new page will have two sections:
      • CLI: For command-line interface instructions (content from the current "Installation" page)).
      • GUI: For graphical client instructions (content from the current "Graphical Clients" page).
    • (Optional for the next step) Potentially adjust "General" and "Privacy Policy" sections under the current "Graphical Clients" tab.
  2. Update Language Code Names:

    • Use ISO 639 and ISO 15924 standards to distinguish Simplified Chinese and Traditional Chinese:
      • Change zh to zh-Hans for Simplified Chinese.
      • Add zh-Hant for Traditional Chinese.
    • This update will also provide better support for additional languages in the future.
  3. Add a Short Introduction in the "Manual" Section:

    • Provide a brief introduction to guide users, especially beginners, who may find it difficult to determine where to start.
    • (Alternative idea): Consider renaming "Manual" to "Get Started", though the current name could be retained as this section includes more than just getting started. Another possible name could be "Handbook"—please share your thoughts.
  4. (Optional) Shorten URLs Across the Site:

    • Adjust existing URLs to be more concise. For example:
      • installationinstall
      • configurationconfig
    • Shorter URLs make it easier to share links and improve overall usability.

Request for Feedback:

Please let me know if these changes align with the project's direction and if there are any additional considerations or suggestions.

Once confirmed, I will begin implementing the changes as described above. Thank you for your time and consideration! Looking forward to your feedback.

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

No branches or pull requests

1 participant