Improve README structure, formatting, and installation clarity. #14#26
Merged
ParzivalHack merged 3 commits intoParzivalHack:mainfrom Jan 14, 2026
Merged
Improve README structure, formatting, and installation clarity. #14#26ParzivalHack merged 3 commits intoParzivalHack:mainfrom
ParzivalHack merged 3 commits intoParzivalHack:mainfrom
Conversation
Fixed markdown inconsistencies in the PR, adjusted spacing when using the emoji "🎉", removed quick start section (as the installation is already comprehensive and, now, easy enough to understand and also, a quick start with all PySpector's pre-requisites would result in smth too long and repetitive), removed venv deactivation part (as the Python3.12 venv is mandatory to use PySpector, when it was installed in it), fixed spacing
ParzivalHack
added
documentation
Owner
|
Hey @RISHIKA-A-S, thanks a lot for your valuable contribution! I made some changes, since i found some formatting issues and markdown inconsistencies in your PR, as you can see in my commit here. Tho i did keep a lot from your original commits, considering you did some great changes to the docs. Thanks again for contributing, your help is much appreciated :) |
ParzivalHack
approved these changes
Jan 14, 2026
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
3 participants
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
This PR improves the PySpector README by fixing markdown rendering issues, clarifying installation steps (especially for Windows), improving navigation with a table of contents, and enhancing overall readability.
Changes Made
Notes
No functional or behavioral changes were made. Documentation-only improvements.
Closes #14