MAINT simplify Getting Started docs#1727
Open
behnam-o wants to merge 2 commits into
Open
Conversation
behnam-o
commented
May 13, 2026
Contributor
Author
behnam-o
left a comment
behnam-o
left a comment
There was a problem hiding this comment.
insert scanner terminal screenshot before merging
rlundeen2
reviewed
May 13, 2026
| ## Getting Started | ||
|
|
||
| Getting PyRIT running takes two steps: **install** the package, then **configure** your AI endpoints. For the path that's right for you, see the [Getting Started](getting_started/README) guide. | ||
| 1. Download and install [Python 3.13](https://www.python.org/downloads/latest/python3.13/). |
Contributor
There was a problem hiding this comment.
I might delete this. It is (or should be) part of "install pyrit" section. Python installation may depend on docker container, etc.
rlundeen2
approved these changes
May 13, 2026
Contributor
rlundeen2
left a comment
rlundeen2
left a comment
There was a problem hiding this comment.
I like this! Let's as @romanlutz to take a look also.
Then I think the top portion could use an update once we have videos
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.
Updating the Getting Stated section with more minimal content that lets a new user get started faster (I think?)
screenshot:
