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
Documentation #94
Comments
I love to help add docs to code but don't know about GoDoc. |
@AnneTheAgile Would love the help! The GoDoc bit is one thing for sure, but there's regular documentation that could use some help from writers too. An exposition on getting started, using Visualize, etc, within |
To extend on this; doc comments can be refined into good godoc during review. Just picking a package and adding doc comments to exported functions, types and methods (and the package decl) is a start in this process. As a tip, running an instance of godoc started by |
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.
The text was updated successfully, but these errors were encountered: