Document Happy Path for crAPI
Open
@chahat99 is already working on this.
Since Oct 8, 2022.
documentation
enhancement
hacktoberfest
- Dominant language
- Java
- Stars
- 1.6k
- Forks
- 645
- Avg merge
- 37m
- Merged PRs (30d)
- 1
Description
Is your feature request related to a problem? Please describe.
Currently, when we start crAPI, we don't know where to click or where to look to generate specific vulnerabilities. We should document a "happy path" or principal workflow which will help people to actually understand the working of the crAPI application.
Describe the solution you'd like
A document with "happy path" and link it in main README.
Describe alternatives if any you've considered
NA
Additional context
NA
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.
Assessment
This issue has not been assessed yet.