DOC GUI: Document dataset workflows and cover cross-flow journeys
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 30/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- playwright, python
- 領域
- backend, documentation, frontend, testing
調査の方向性
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.
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- Python
- スター
- 4.5k
- フォーク
- 896
- 平均マージ
- 3日 2時間
- マージ済み PR（30日）
- 210
環境構築
このプロジェクトの環境構築ファイルはまだ確認していません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
microsoft/PyRIT のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 91/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
メンテナーはふだん 1 日以内に返信
-
Bug: triage GUI help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
microsoft/PyRIT#2868 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
microsoft/PyRIT の issue をすべて見る
似ている issue
-
needs triage
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
openvinotoolkit/openvino_notebooks#3665 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
メンテナーはふだん 1 日以内に返信
-
docs
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
benchmark-gap
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信