Docs: Autogenerate threats into docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 229
- PR merge metrics
- No merged PRs in 30d
Description
If we#d use mkdocs for generating docs we could use the approach represented in https://github.com/mkdocs/mkdocs/discussions/3487#discussioncomment-7681213 potentially to free our self from manually updating supported threats defined in https://github.com/OWASP/pytm/blob/master/pytm/threatlib/threats.json into https://github.com/OWASP/pytm/blob/master/docs/threats.md .
Would this be helpful @Dakes @nineinchnick ?
This idea would align with other ideas like #279 .
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
Start by reading pytm/threatlib/threats.json and docs/threats.md, then review the linked MkDocs discussion and related issue #279. The work is done when the documentation is generated from the supported threats data and no longer requires manually duplicating threat entries.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100