docs: Update documentation #25
Open
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
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for Revenge Manager by restructuring the table of contents and adding new pages for installation, getting started, and usage instructions.
- Updated README.md with a new table of contents linking to various documentation pages
- Added new documentation files: 1_installing.md, 2_getting_started.md, and 3_using.md to guide users through installation, setup, and configuration
- Enhanced clarity in navigation and content flow for the documentation
Reviewed Changes
Copilot reviewed 4 out of 6 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/README.md | Updated table of contents with links to new documentation pages |
| docs/3_using.md | Added detailed guide for using and configuring Revenge Manager |
| docs/2_getting_started.md | New step-by-step guide to getting started with Revenge Manager |
| docs/1_installing.md | New installation guide with hardware requirements and steps |
Comments suppressed due to low confidence (2)
docs/1_installing.md:11
- [nitpick] Consider revising this sentence for clarity and proper grammar, for example: 'follow the steps on the screen to install the app, then open it.'
follow the step on the screen to install then open it.
docs/3_using.md:55
- [nitpick] The note regarding Developer Options might be confusing; consider rephrasing for clarity, such as specifying that documentation for Developer Options is not provided.
> You may have the option to toggle Developer Options here, documentation is not
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.
I don't know what style guide should I use, I just go for blend of Google style
Markdown style: https://google.github.io/styleguide/docguide/style.html
Wording style: https://developers.google.com/style
Did I talk to mlap about this, no absolutely not