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

Implement Troubleshooting Section for Common Errors and Solutions #553

Open
2 tasks done
pratrivedi opened this issue Oct 13, 2024 · 1 comment
Open
2 tasks done
Assignees
Labels
c-feature Category: New feature or request p-low Priority: Low Priority task

Comments

@pratrivedi
Copy link
Contributor

Prerequisites

  • I checked the documentation and made sure this feature does not already exist
  • I checked the existing issues to make sure this feature has not already been requested

Feature

Adding a dedicated Troubleshooting Section to the documentation or project repository. This section will focus on listing common errors, their causes, and solutions encountered by users. By having this centralized, easily accessible section, we can reduce repetitive queries from users and speed up issue resolution.

Additional Information (Optional)

No response

@jrriehl jrriehl added c-feature Category: New feature or request p-low Priority: Low Priority task labels Oct 14, 2024
@Archento
Copy link
Member

Thank you for that suggestion!

I strongly think that this should be part of the documentation and that the repo should only have the source code and basic usage examples (which in turn should be self explanatory).
This to me means that this currently isn't the case and we should be more verbose and descriptive in the code and/or examples.

Please expect a refactoring of the repo to happen soon and after that we can close this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c-feature Category: New feature or request p-low Priority: Low Priority task
Projects
None yet
Development

No branches or pull requests

4 participants