Issues¶
Reporting an issue? Here are the following things to keep in mind.
What qualifies as an issue¶
While not an exhaustive list of valid issues, this list is generally enough to cover the most common issues a user can have with this guide.
- Typos, whether in the formatting or in the prose content
- Bugs with navigation, search, etc.
- Potentially incorrect information
Issues that we can't fix¶
These are issues that cannot be fixed for reasons out of our control.
Upstream issues¶
Anything regarding the systems of Zensical or the libraries we use will be marked as upstream until we can close the issue after the respective developers fix their software. Yes, we can go fix it ourselves if we could but the problem is that we can't. Only the maintainers of said libraries know exactly what goes on with them.
LLM output derived from this website¶
We will not fix issues or respond to queries about LLMs outputting incorrect information based on our website as the source. As there are varying tiers of LLMs, both local and online, we cannot spend much time testing to see if each LLM properly outputs what the user wants.
Any hallucination or made-up facts usually stem from the LLM being forced to always answer even if the answer itself is bad quality. It is far more productive that we spend time on improving the accessibility of our prose. That way, we guarantee the quality of the prose and it may indirectly improve the LLM output experience in this area.
TL;DR: Please do not ask us to fix problems that can be addressed by simply reading the actual prose we write.
Preparing your report¶
Your report of the issue does not have to follow strict formatting or language guidelines. Please note however that the following information may be required:
- Details about your device(s): For technical bugs and issues.
- Specific link to the page(s): For typos, misspellings, broken formatting.
- Official confirmation: For information that is no longer correct.
Locations to report an issue¶
Ready to notify us of the issue? Here are the places that we look at to resolve any issues you have with the project.
Codeberg¶
You can report the issue you are having with the guide using the Issues tab on Codeberg.
Making an issue on the repository requires a Codeberg account. However, if you already have a GitHub account, you can "sign in with GitHub" on Codeberg, which creates a new account.