Added new Documentation section and installation guide link reference to the Setup section#2172
Open
ThatTotallyRealMyth wants to merge 2 commits into
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
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.
Hi there, I noticed on #1566 and in other online channels such as on discord etc people don't appear to know there's documentation for impacket and that there's a API reference present.
Additionally the setup section in the readme could be better placed to have a reference to the fuller installation guide that includes a lot more details such as supported python versions, troubleshooting, how to set up virtual environments, and upgrading the lib.
This PR creates a new section,
Documentation, and added a link to reference the installation guide in thesetupsection.Happy to change the order or anything but I think this is simple, clean and offers a proper way for people to find the impacket documentation to make the project more accessible.