DOC write doc page on how to create a new target

Open
#642 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
58/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Start by surveying the existing documentation and the AML target implementation to understand the requirements and the distinction between multi-turn and single-turn targets. Use the current AML target or another HTTP-based target as the example, and consider the work complete when the page covers the requirements, both target modes, and a concrete endpoint-adjustment walkthrough.

Written by the indexing model from the issue text.

Description

documentation
Describe the issue linked to the documentation

This is a common question. The page should at least describe

  • all the requirements for a target
  • multi-turn vs single-turn targets
  • an actual example of how to adjust AML target or another one to a different HTTP based endpoint
Suggest a potential alternative/fix
Dominant language
Python
Stars
4.5k
Forks
896
Avg merge
3d 7h
Merged PRs (30d)
155

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/PyRIT

All issues in microsoft/PyRIT

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.