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

[docs] first steps is unclear: #1403

Closed
qdraw opened this issue Feb 21, 2024 · 0 comments · Fixed by #1422
Closed

[docs] first steps is unclear: #1403

qdraw opened this issue Feb 21, 2024 · 0 comments · Fixed by #1422
Labels
enhancement New feature or request
Milestone

Comments

@qdraw
Copy link
Owner

qdraw commented Feb 21, 2024

Problem:

The documentation provided at https://docs.qdraw.nl/docs/getting-started/first-steps is unclear regarding the configuration process. Specifically, there are ambiguities in the instructions provided for setting up library preferences and advanced settings.

Solution:

  • Provide more detailed explanations and examples for configuring library preferences and advanced settings. For example, elaborate on the available options beyond "Verbose logging" and "Storage folder," and provide clear explanations of each option's purpose and potential impact.
    Clarify the difference between various settings and provide guidance on how to choose the most suitable options based on individual preferences and use cases.

Alternatives:

  • Include tooltips or inline explanations within the user interface to provide additional context and guidance for each setting.
    Create video tutorials or step-by-step guides to supplement the written documentation and help users understand the configuration process more effectively.

Additional Context:

Improving the clarity of the documentation and providing more detailed explanations will enhance the user experience, reduce confusion, and empower users to configure the software according to their preferences with confidence.

(Chris - 20-2)

@qdraw qdraw added the enhancement New feature or request label Feb 21, 2024
@qdraw qdraw added this to the Release 0.6.0 milestone Feb 21, 2024
@qdraw qdraw linked a pull request Feb 29, 2024 that will close this issue
22 tasks
@qdraw qdraw mentioned this issue Feb 29, 2024
22 tasks
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

Successfully merging a pull request may close this issue.

1 participant