Skip to content

Commit

Permalink
generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jiachengxu committed Jul 25, 2024
1 parent cf68270 commit 8664e97
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@ Before adding a new risk type, please check if the risk type ID is already taken

Create a folder under [src](https://github.com/cryptousersecurity/token-risk-classification/tree/main/src) folder with the name of the risk type ID. Add folders and files based on the [Risk Type Format](#risk-type-format) section.

### Update mkdocs.yml

Add the new risk type to the `Risk Types` list under `nav` section in [mkdocs.yml](https://github.com/cryptousersecurity/token-risk-classification/blob/main/mkdocs.yml#L17).

## Update Documentation
Everytime you add a new risk type or add new risk samples to an existing risk type, please update the documentation by executing the following command:
```bash
Expand Down

0 comments on commit 8664e97

Please sign in to comment.