docs: refresh documentation and add a troubleshooting page #410
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shreddedbacon
changed the title
shreddedbacon
force-pushed
the
docs-overhaul
branch
from
194b13b to
128eb2e
Compare
shreddedbacon
force-pushed
the
docs-overhaul
branch
from
128eb2e to
97330a4
Compare
CGoodwin90
approved these changes
Dec 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
General Checklist
The
configurationdocs were a bit out of date and referenced some amazeeio domains that shouldn't be used anymore. Eventually I'd like to remove the references to amazeeio, but that can be done in #319. This updates them with some newer output examples, and some changes to wording.Fixed up a weird issue with the add and update variable commands so now the docs are correct.
Added a make target to serve the docs locally to edit docs and see changes easier. Big note, don't modify the
commands/*files as they are still auto generated bymake docs.I also put together some basic troubleshooting information. Hopefully this will help some users resolve some problems themselves.
This has to merge after #409