docs: add first-use guide after login#264
Open
mason5052 wants to merge 2 commits intovxcontrol:mainfrom
Open
Conversation
Signed-off-by: Mason Kim(ZINUS US_SALES) <mkim@zinus.com>
There was a problem hiding this comment.
Pull request overview
Adds a first-use onboarding section to the README to help new users go from “logged into the UI” to running their first flow, addressing Issue #61.
Changes:
- Adds a “How to Use PentAGI After Login” section describing the first
Flows → New Flowworkflow. - Documents the difference between Automation vs Assistant modes and how to write an initial goal prompt.
- Explains using Templates and where to view/export reports from the flow page.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+962
to
+965
| Example: | ||
|
|
||
| ```text | ||
| Assess https://target.example for common web application vulnerabilities. Focus on authentication, file handling, and injection issues. Stay within the provided target only and summarize confirmed findings with reproduction steps. |
Signed-off-by: Mason Kim(ZINUS US_SALES) <mkim@zinus.com>
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
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
Flows -> New Flowworkflow for both Automation and Assistant modesProblem
Issue #61 points out that the repository explains how to install PentAGI, but not how to actually start using it once the web UI is available.
Right now the README covers deployment, provider setup, API access, and advanced configuration, but it does not give new users a simple path from "I can log in" to "I can run my first useful flow."
Solution
Add a README-only onboarding section between Quick Start and API Access that walks through the first practical user workflow:
Flowsand create a new flowAutomationandAssistantexamples/prompts/base_web_pentest.mdas a concrete starting pointReportmenuThis keeps the contribution small while making the existing UI much easier to approach for first-time users.
User Impact
New users can move from installation to their first useful assessment without digging through the codebase or guessing how the UI is meant to be used. The README now provides a clearer bridge between setup and day-to-day usage.
Closes #61.
Test Plan
Flows,New Flow,Automation,Assistant,Templates,Report)examples/prompts/base_web_pentest.mdgit diff --check