nspcc-dev / nspcc-dev/neofs-node
Autogenerate protobuf documentation
Open
Nobody has claimed this yet.
documentation
feature
I4
S3
U3
- Dominant language
- Go
- Stars
- 38
- Forks
- 51
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 38
Description
It would be nice to have human-readable documentation generated from our proto files, similar to how it is done for neofs-api repo.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by examining the repository's proto files and the analogous documentation generation setup in the neofs-api repository. Define how the generation should fit this project and verify that it produces human-readable documentation from the proto files.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100