MAINT simplify Getting Started docs#1727
Conversation
behnam-o
left a comment
behnam-o
left a comment
There was a problem hiding this comment.
insert scanner terminal screenshot before merging
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
| 1. Install PyRIT and verify installation.\ | ||
| For more details and alternative installation methods, see the [Install PyRIT](getting_started/install) page\ | ||
| ```bash | ||
| # note: for local installation, python version 3.13 is recommended: https://www.python.org/downloads/latest/python3.13 |
There was a problem hiding this comment.
Why 3.13? We support 3.10-14
There was a problem hiding this comment.
Hmm, looks like 3.14 support was added 2 weeks ago here, so pyrit v0.13 (latest on pypi) does not support that.
If we publish the doc saying python 3.14 , it only works for people cloning the repo, not those who just want the pypi package
There was a problem hiding this comment.
imo this doesn't really add more than a few images and if we're going to have a gif / video, i think it makes more sense to show sequentially how to get from one page to another like more of a walkthrough
There was a problem hiding this comment.
just noting that we don't usually remove the user name from our notebooks at least and its obviously fine to remove but i'm wondering if we could just replace it with like roakey or make the block a little cleaner (like ask copilot to generate an image with it blocked out)
|
|
||
| ## Getting Started | ||
| 1. Install PyRIT and verify installation.\ | ||
| For more details and alternative installation methods, see the [Install PyRIT](getting_started/install) page\ |
There was a problem hiding this comment.
i think you need a space here:
4 participants
Updating the Getting Stated section with more minimal content that lets a new user get started faster (I think?)
screenshot:
