matrix-org / matrix-org/gomatrixserverlib
Add better GoDoc
Open
Nobody has claimed this yet.
T-Other
- Dominant language
- Go
- Stars
- 67
- Forks
- 60
- PR merge metrics
- No merged PRs in 30d
Description
We haven't spent time to give a holistic view of what this library looks like on GoDoc.
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 with the library's GoDoc entry point and review how its exported packages and symbols are currently presented. Define a holistic overview of the library and document the missing context in GoDoc; done means the library is easier to understand as a whole from its GoDoc.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100