crytic/Document with Slither
Generates documentation for your smart contracts using Slither and OpenAI
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| target | Project target | yes | . |
| openai-api-key | OpenAI API key | yes | — |
| trigger-label | Label used to trigger the workflow. Will be removed once documentation is generated. | — | generate-docs |
| slither-version | Slither version to install. Defaults to the latest release on PyPI. | — | latest |
| solc-version | solc compiler version to install. Note that this is only used when target is a standalone Solidity code file or folder. | — | none |
| github-token | GitHub token, used to compute PR differences and push documentation. | — | ${{ github.token }} |
Outputs
no outputs