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

documentation tracking issue #1859

Open

5 tasks

0xalpharush opened this issue Apr 24, 2023 · 0 comments

Labels

High Priority tracking

Contributor

0xalpharush commented Apr 24, 2023 •

edited

Loading

We should migrate away from github wiki and do the following:

move detectors' wiki and detector table to auto-generated markdown in docs
- change format something like https://beta.ruff.rs/docs/rules/bad-quotes-docstring/
create a page for each printer and tool
create architecture diagram for CONTRIBUTING.md
enforce documentation style and add docs where they are missing

This will probably require moving away or adding a separate documentation site as pdoc is best suited for API docs

The text was updated successfully, but these errors were encountered:

0xalpharush added the tracking label

0xalpharush added the High Priority label

0xalpharush mentioned this issue

properties, documentation: correct tool descriptions and usage #2311

Merged

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