DOC GUI: Document dataset workflows and cover cross-flow journeys
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 30/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- playwright, python
- Ambito
- backend, documentation, frontend, testing
Direzione di ricerca
Wait until the prerequisite milestones are promoted, then read the applicable documentation, frontend, Python, and test instructions. Start in doc/gui and frontend/e2e, tracing the feature's local fixture/setup helpers and existing GUI documentation; run the fixture-based workflows with the established harness. Done means the guide reflects shipped labels, routes, defaults, and limitations, while real-backend flows cover handoffs, draft preservation, exact selections, accessibility, and error states without privileged access or secrets.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Describe the issue linked to the documentation
The completed dataset explorer needs a concise user guide and contributor-friendly end-to-end examples. Users must understand the difference between loading a dataset, importing one example into an editable chat draft, and configuring a scenario from multiple selected examples.
Work item 17 of 17 in #2744. Prerequisites: the completed memory/chat, provider-loading, and custom-scenario milestones (items 1-16). Keep not ready yet until promoted. Earlier issues must ship their own focused tests; this item does not postpone that responsibility.
Suggest a potential alternative/fix
Add a short guide in the existing GUI documentation and cross-flow coverage using the established test harness.
Document:
- Browsing memory-backed dataset cards, count semantics, missing metadata, filters, prompt details, and multimodal previews.
- The three single-example import destinations and the guarantee that importing only fills an editable draft. Explain draft replacement and return-to-chat behavior.
- Explicit provider loading, supported options, backend credential configuration, external gated-access prerequisites, error/retry behavior, and shared-memory scope. Do not include secrets or imply that a token automatically grants dataset access.
- Multi-select to Configure scenario, exact selected-example semantics, prompt-sending/no-additional-converter defaults, configured scorer presets, missing-objective requirements, confirmation, and normal scenario progress/history.
- Unsupported formats/seed shapes and relevant limitations, including the distinction between a non-refusal scorer and a task-achievement scorer.
Cross-flow coverage:
- Browse a local dataset, inspect text plus media, import into each supported draft destination, and verify that no target call occurs before explicit Send.
- Leave chat with a nonempty draft, visit Datasets, and return without losing text, attachments, or context.
- Exercise provider loading success and access/failure guidance with deterministic local/fake providers.
- Select examples across pages, configure a scenario, and verify preview/estimate/launch agree on exact selections and defaults. Exercise an alternate compatible technique/converter/scorer configuration.
- Include keyboard navigation and representative narrow-viewport/error states.
Use the real backend for Playwright end-to-end flows with controlled local fixture providers/targets/scorers. Component tests may mock API services according to repository conventions; do not replace the real stack with API mocks in end-to-end tests. Tests and documentation examples must not require privileged Hugging Face access, real secrets, or paid model calls.
Acceptance criteria:
- The guide matches the shipped labels, routes, defaults, and limitations.
- A contributor can run the documented fixture-based workflows without gated datasets or credentials.
- Cross-flow tests cover chat and scenario handoffs and detect accidental sends, lost drafts, and changed selections.
- Existing GUI documentation is updated rather than duplicated in an unrelated guide.
Start with doc\gui and frontend\e2e plus the feature's local fixture/setup helpers. Follow applicable documentation, frontend, Python, and test instructions.
- Lingua principale
- Python
- Stelle
- 4.5k
- Fork
- 896
- Merge medio
- 3g 8h
- PR unite (30g)
- 191
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di microsoft/PyRIT
-
BUG HarmBench loader drops ContextString, so contextual behaviors are sent without their context Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
Tutte le issue di microsoft/PyRIT
Issue simili
-
agent-ready documentation needs-triage
Difficoltà 1/5 1-3 ore Idoneità per principianti 88/100
-
documentation
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 92/100
-
instance instance add
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 72/100
searxng/searx-instances#939 · 1 commento ·
-
area-deployment area-integrations triage:bot-seen
Difficoltà 2/5 Mezza giornata Idoneità per principianti 86/100