projectdiscovery / projectdiscovery/docs
Updates to Fuzzing Documentation
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 28
- Forks
- 62
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 3
Description
Objective: Update the fuzzing documentation to incorporate insights from Brendan's BSides presentation, helping users better understand how to use fuzzing templates. Additionally, include "DAST" as the flag and update the wording accordingly.
Tasks:
-
Review Brendan's Presentation:
- Obtain and review the presentation materials from Brendan's BSides talk.
- Extract key insights and examples that can enhance the fuzzing documentation.
-
Update Fuzzing Templates Section:
- Revise the section on fuzzing templates to include detailed explanations and examples from the presentation.
- Ensure that the documentation clearly guides users on how to effectively use fuzzing templates.
-
Incorporate "DAST" Flag:
- Update the documentation to include "DAST" as a flag.
- Provide a clear explanation of the "DAST" flag and how it is used in fuzzing.
- Update any examples and command-line instructions to reflect the use of the "DAST" flag.
-
Revise Wording:
- Ensure that the overall wording of the documentation is updated to include "DAST" where relevant.
- Make the language more user-friendly and accessible, incorporating feedback from Brendan's presentation.
-
Review and Approve:
- Share the updated documentation with relevant stakeholders, including Brendan, for review and approval.
- Incorporate any feedback and make necessary revisions.
-
Publish Updates:
- Update the fuzzing documentation on the documentation site.
- Ensure the changes are live and verify that the updated information is displayed correctly.
Acceptance Criteria:
-
The fuzzing documentation is updated with insights and examples from Brendan's BSides presentation. -
The "DAST" flag is included in the documentation with clear explanations and examples. -
The wording throughout the documentation is revised to be user-friendly and include "DAST" where relevant. -
The updated documentation is reviewed, approved, and published on the site.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the fuzzing documentation and Brendan's BSides presentation materials first. Update the fuzzing templates guidance, DAST flag explanations, and examples, then verify the published documentation and incorporate stakeholder feedback before considering the work complete.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100