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.

Sign up for GitHub

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

Jump to bottom

Troubleshooting guide and Error description documentation #125

Closed
mkrupczak3 opened this issue Apr 19, 2024 · 1 comment
Closed

Troubleshooting guide and Error description documentation #125

mkrupczak3 opened this issue Apr 19, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@mkrupczak3
Copy link
Member

mkrupczak3 commented Apr 19, 2024 •
edited
Loading

There is no information in the README for common troubleshooting steps. A troubleshooting document should be provided to allow the user to rapidly understand and fix (or otherwise understand and work around) possible error conditions
@mkrupczak3 mkrupczak3 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 19, 2024
@mkrupczak3
Copy link
Member Author

Added TROUBLESHOOTING.md document in 424836a and 4b8f0b9, now just need to link to from the main README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mkrupczak3