New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improving our Documentation #199

Open

1 of 8 tasks

cerrussell opened this issue Dec 27, 2023 · 0 comments

Assignees

Collaborator

cerrussell commented Dec 27, 2023 •

edited by saketjajoo

Add a table of contents at the top of our ReadMe
Create a Read the Docs
- Create documentation with sphinx
- Break down existing ReadMe into smaller chunks for user documentation
- Enable access for read the docs in owasp-dep-scan
- Import to Read the Docs
- Simplify our ReadMe to include only basic usage information and redirect to the full documentation
Add a page about contributing to owasp-dep-scan

cerrussell self-assigned this

cerrussell mentioned this issue

chore: Add a table of contents at the beginning of README.md #200

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment