vxcontrol/pentagi
1
0
Fork 0
mirror of https://github.com/vxcontrol/pentagi.git synced 2026-07-20 23:57:11 -04:00
Code Issues 45 Packages Projects Releases 9 Wiki Activity

[PR #264] [MERGED] docs: add first-use guide after login #279

New Issue
Closed
opened 2026-06-06 22:10:01 -04:00 by yindo · 0 comments
yindo commented 2026-06-06 22:10:01 -04:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/vxcontrol/pentagi/pull/264
Author: @mason5052
Created: 4/15/2026
Status: ✅ Merged
Merged: 4/22/2026
Merged by: @asdek

Base: feature/next-release ← Head: codex/issue-61-first-use-guide

📝 Commits (2)

  • af1bf04 docs: add first-use guide after login
  • a07c28c docs: add authorized-use reminder

📊 Changes

1 file changed (+57 additions, -0 deletions)

View changed files

📝 README.md (+57 -0)

📄 Description

Summary

  • add a first-use guide for the PentAGI web UI after installation and login
  • document the initial Flows -> New Flow workflow for both Automation and Assistant modes
  • explain how to use templates and where to find report output in the flow UI

Problem

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:

  • open Flows and create a new flow
  • choose between Automation and Assistant
  • select a provider and write the goal in natural language
  • optionally apply a saved template, with examples/prompts/base_web_pentest.md as a concrete starting point
  • review results from the flow page and export reports from the Report menu

This 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

  • Verified the new section title and Table of Contents anchor match
  • Verified README terminology against the current UI (Flows, New Flow, Automation, Assistant, Templates, Report)
  • Verified the example prompt link points to examples/prompts/base_web_pentest.md
  • Verified the text does not claim any new runtime behavior or UI changes
  • git diff --check

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/vxcontrol/pentagi/pull/264 **Author:** [@mason5052](https://github.com/mason5052) **Created:** 4/15/2026 **Status:** ✅ Merged **Merged:** 4/22/2026 **Merged by:** [@asdek](https://github.com/asdek) **Base:** `feature/next-release` ← **Head:** `codex/issue-61-first-use-guide` --- ### 📝 Commits (2) - [`af1bf04`](https://github.com/vxcontrol/pentagi/commit/af1bf049aff68037e84b34d3b2c12d05d35720af) docs: add first-use guide after login - [`a07c28c`](https://github.com/vxcontrol/pentagi/commit/a07c28c2aea11870e58ecafa3e35bc78d016621a) docs: add authorized-use reminder ### 📊 Changes **1 file changed** (+57 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+57 -0) </details> ### 📄 Description ## Summary - add a first-use guide for the PentAGI web UI after installation and login - document the initial `Flows -> New Flow` workflow for both Automation and Assistant modes - explain how to use templates and where to find report output in the flow UI ## Problem 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: - open `Flows` and create a new flow - choose between `Automation` and `Assistant` - select a provider and write the goal in natural language - optionally apply a saved template, with `examples/prompts/base_web_pentest.md` as a concrete starting point - review results from the flow page and export reports from the `Report` menu This 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 - [x] Verified the new section title and Table of Contents anchor match - [x] Verified README terminology against the current UI (`Flows`, `New Flow`, `Automation`, `Assistant`, `Templates`, `Report`) - [x] Verified the example prompt link points to `examples/prompts/base_web_pentest.md` - [x] Verified the text does not claim any new runtime behavior or UI changes - [x] `git diff --check` --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-06-06 22:10:01 -04:00
yindo closed this issue 2026-06-06 22:10:01 -04:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
enhancement
help wanted
pull-request
Mirrored from GitHub Pull Request
 question
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: vxcontrol/pentagi#279
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?