Improved Documentation #189
Open
+30
−0
Conversation
This file contains 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
treetrum
requested changes
Feb 22, 2025
Comment on lines
+5
to
+14
| # Table of Contents | ||
|
|
||
| 1. What This Tool Does | ||
| 2. Disclaimer | ||
| 3. Pre-Requisites | ||
| 4. Installation | ||
| 5. Running the Tool | ||
| 6. CLI Arguments | ||
| 7. Troubleshooting | ||
| 8. Contribution Guide |
There was a problem hiding this comment.
We can drop the table of contents IMO. Github already provides a native TOC for markdown files.
| @@ -96,3 +114,15 @@ There has also [been an indication](https://github.com/treetrum/amazon-kindle-bu | |||
| #### Error: Failed to parse CRSF token | |||
|
|
|||
| This indicates that your login did not fully succeed. There are a multitude of reasons why this could happen however the simplest fix is often to login using the --manualAuth CLI flag instead of using the automated process. | |||
|
|
|||
| ### Contributions | |||
There was a problem hiding this comment.
This should be a H2. If it's a H3, it becomes part of the troubleshooting section.
|
You will also need to fix the prettier issues referenced in the failed build. |
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.
Improved documentations on a disclaimer for potential amazon TOS, a contribution guide, and table of contents.