Skip to content
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.

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

Update documentation links within detectors #220

Closed
arturoBeccar opened this issue May 10, 2024 · 0 comments · Fixed by #224
Closed

Update documentation links within detectors #220

arturoBeccar opened this issue May 10, 2024 · 0 comments · Fixed by #224
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@arturoBeccar
Copy link
Member

Description

Make changes in every detector to ensure that the linked documentation in the help field points to the detector's documentation in docusaurus.

For example:

For assert-violation we should replace:

       name: "Assert Violation",
        long_message: "Assert causes panic. Instead, return a proper error.",
        severity: "Medium",
        help: "https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/assert-violation",
        vulnerability_class: "Panic",

For

       name: "Assert Violation",
        long_message: "Assert causes panic. Instead, return a proper error.",
        severity: "Medium",
        help: "https://coinfabrik.github.io/scout-soroban/docs/detectors/assert-violation",
        vulnerability_class: "Panic",
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants