Glide, the package manager for Go, now has user documentation that’s more accessible and easy to contribute to.
Package documentation for Go packages provide an easy way to learn about using packages within your own codebase. But, they aren’t ideal (when compared to alternatives) for user application documentation. With Glide we needed both.
To that end, Glide now has user documentation on Read the Docs. This documentation is searchable and can be downloaded in other formats (e.g., PDF).
The initial documentation is limited and we will be adding to it. But, if you’re interested in contributing to the docs, which is a contribution to Glide, that’s easy. Here’s how to get started.
- Fork Glide on GitHub.
- Add or otherwise alter the documentation in the
docsfolder. This is fairly straight forward markdown.
- If you’ve added a new top level menu option be sure to update the
mkdocs.ymlfile in the root of the project.
- Create a pull request back to Glide and we’ll review it.
The documentation is generated using MkDocs by Read the Docs.