crytic/slither

slither-doc: generate doc from natspec

Open

#857 opened on May 28, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (886 forks)batch import
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (4,769 stars)
PR merge metrics
 (Avg merge 54d 9h) (2 merged PRs in 30d)

Description

From @Arachnid recent tweet, it looks like there is not good up to date solution to generate doc from natspec. We should explore the current solutions and create something on top of slither

Contributor guide

Research direction
Explore existing documentation generation tools for Solidity natspec and design a solution to integrate with slither.
Tech stack
python
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGitSolidity
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50