Skip to content

DOC: Simplify GUI guide and add page screenshots - #3502

Open
Richard Lundeen (richlundeen) wants to merge 2 commits into
microsoft:mainfrom
richlundeen:richlundeen-gui-guide-rewrite
Open

Richard Lundeen (richlundeen) wants to merge 2 commits into
microsoft:mainfrom
richlundeen:richlundeen-gui-guide-rewrite

Conversation

@richlundeen

Copy link
Copy Markdown
Contributor

Description

Replace the long GUI reference with concise, page-specific overviews and 11 current screenshots from an isolated offline backend.

  • Separate manual Chat from the automated technique.execute scenario and show the actual execution setup.
  • Explain the roles of Home, Scanner, Registry, Datasets, History, Analytics, Operations, and Configuration.
  • Correct Registry capabilities and distinguish live components from saved presets and suites.
  • Remove field-level instructions and internal API details, and update links to removed sections.

Documentation only; application behavior is unchanged. The existing sidebar label that calls /chat “Technique.execute” is not changed here.

Tests and Documentation

  • uv run --no-sync pre-commit run --all-files — passed all hooks, including documentation structure, type checking, and notebook checks.
  • uv run --frozen --no-sync python -m build_scripts.pydoc2json pyrit --submodules -o doc\_api\pyrit_all.json — passed; API extraction reported docstring warnings.
  • uv run --frozen --no-sync python -m build_scripts.gen_api_md — passed.
  • uv run --frozen --no-sync python -m build_scripts.validate_docs — passed.
  • From doc: uv run --frozen --no-sync jupyter-book build --html --strict — passed with warnings.
  • Checked local guide links and verified all 11 screenshots as readable 1664×1000 PNG files. Compared the overviews with the current routes and page implementations.

Unit/integration tests and JupyText execution were not run: no application code or notebook content changed.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant