cayleygraph / cayleygraph/cayley
Documentation
- Dominant language
- Go
- Stars
- 15.1k
- Forks
- 1.2k
- PR merge metrics
- No merged PRs in 30d
Description
This is a catchall issue.
As highlighted in #91, a significant proportion of the exported codebase lacks doc comments or the comments are not associated with the relevant labels according to the godoc conventions (and so are missed by golint and godoc).
It might be worth considering adding a page to the wiki on graph databases in general (and links to resources). This kind of approach to client education has been very successful in growing the Go userbase with the {talks,blog}.golang.org pages and the go-tour.
Contributor guide
Research direction
Start by reviewing the exported Go code against godoc conventions and checking which comments are missed by golint and godoc. Inventory missing or misassociated doc comments, then separately assess the proposed wiki page on graph databases and its resource links. Done should be defined as a focused, reviewable documentation scope rather than this catchall issue.
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
- 25/100