docs: streamline documentation and clean up verbose comments#59
Merged
Conversation
- Simplify quickstart guide: remove redundant install step, condense Cheat Engine workflow explanation, restructure pointer scan section into a clear 3-step save/rescan/load workflow - Update app.md feature list: consolidate scanner details, add Modules section, reword descriptions for brevity - Fix pointer-scan guide examples to use a single 'scan.json' file consistently and add a 'Load saved paths' subsection - Remove verbose inline comments from pyproject.toml extras - Fix rescan_pointer_paths docstring example (scan.json, not scan1/scan2)
github-actions
Bot
added
docs
JeanExtreme002
changed the title
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
scan.jsonfile consistently and add a "Load saved paths" subsectionrescan_pointer_pathsdocstring example to usescan.jsoninstead ofscan1.json/scan2.json