Go Documentation

Open-source Go projects categorized as Documentation
Edit details
Topics: Golang Go OpenAPI API Data Visualization
The modern identity platform for B2B SaaS
The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.
workos.com
Sponsored

Top 21 Go Documentation Projects

  • cheat

    cheat allows you to create and view interactive cheatsheets on the command-line. It was designed to help remind *nix system administrators of options for commands that they use frequently, but not frequently enough to remember.

    • Project mention: Should you add screenshots to documentation? | news.ycombinator.com | 2023-12-14

    Looks like bro pages is archived and they recommend https://github.com/tldr-pages/tldr or https://github.com/cheat/cheat

  • 100-go-mistakes

    📖 100 Go Mistakes and How to Avoid Them

    • Project mention: Is there a good place to find best practices? | /r/golang | 2023-06-06

    I usually see and recommend: https://go.dev/talks/2013/bestpractices.slide#1 https://go.dev/talks/2014/readability.slide#1 https://github.com/golang/go/wiki/CodeReviewComments https://about.sourcegraph.com/blog/go/idiomatic-go https://github.com/teivah/100-go-mistakes

  • InfluxDB

    Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

    InfluxDB logo

  • terraform-docs

    Generate documentation from Terraform modules in various output formats

    • Project mention: Managing Infrastructure as Code (IaC) With Terraform | dev.to | 2024-04-09

    Documentation is really important, so having a README.md file inside your Terraform repository that explains how to use the automation (including descriptions of variables and outputs) really help in understanding what has been implemented. To easily generate the description of variables and outputs, you can leverage tfdocs.

  • go-recipes

    🦩 Tools for Go projects

    • Project mention: 2023 update to go-recipes collection | /r/golang | 2023-12-11

  • kin-openapi

    OpenAPI 3.0 (and Swagger v2) implementation for Go (parsing, converting, validation, and more)

    • Project mention: Create Production-Ready SDKs With gRPC Gateway | dev.to | 2023-12-08

    We'll use the excellent kin-openapi Go library to convert the OpenAPI 2.0 schema to OpenAPI 3.0.

  • docuowl

    🦉 A documentation generator

  • huma

    A modern, simple, fast & flexible micro framework for building HTTP REST/RPC APIs in Go backed by OpenAPI 3 and JSON Schema.

    • Project mention: I write HTTP services in Go after 13 years (Mat Ryer, 2024) | news.ycombinator.com | 2024-02-09

  • WorkOS

    The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

    WorkOS logo

  • xc

    Markdown defined task runner.

    • Project mention: Runme – Interactive Runbooks Built with Markdown | news.ycombinator.com | 2023-08-24

    Nice!

    Xc is another doing a similar job

    https://xcfile.dev/

  • doctree

    First-class library documentation for every language (based on tree-sitter), with symbol search & more. Lightweight single binary, run locally or self-host. Surfaces usage examples via Sourcegraph.

  • namaste-go

    A repository to learn the basics of Go Programming. The language was developed by Google Engineers but currently is widely used in the Cloud Native ecosystem. If you want to start your career in the landscape this is the starting point.

  • go-redoc

    go-redoc is an embedded OpenAPI/Swagger documentation ui for Go using ReDoc

  • go-notebook

    Go-Notebook is inspired by Jupyter Project (link) in order to document Golang code.

  • spectest

    A simple and extensible behavioural testing library for Go. You can use api test to simplify REST API, HTTP handler and e2e tests.

    • Project mention: actions-hottest🚀: GitHub Actions for Commenting on Golang Unit Test Results in Pull Requests | dev.to | 2023-12-02

    I previously introduced a feature in the go-spectest/spectest, which extracts error messages from Golang unit test results.

  • jotbot

    JotBot generates the missing code documentation for your Go and TypeScript projects. Powered by AI.

  • examples

    A collection of examples for SpiceDB users (by authzed)

  • instaunit

    A tool for testing and documenting Web APIs

  • community

    Community Information for Vela (Target's official Pipeline Automation Framework) (by go-vela)

  • cobradoc

    Alternative documentation generator for Cobra.

  • openapi-inline-examples

    🌏 Inline OpenAPI JSON examples from filenames

  • tblsrun

    Generate database documentation from migration files

  • jsonata-playbook

    practical examples of jsonata [go-jsonata 1.5.4]

  • SaaSHub

    SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives

    SaaSHub logo
NOTE: The open source projects on this list are ordered by number of github stars. The number of mentions indicates repo mentiontions in the last 12 Months or since we started tracking (Dec 2020).

Go Documentation related posts

Index

What are some of the best open-source Documentation projects in Go? This list will help you:

Project Stars
1 cheat 11,940
2 100-go-mistakes 6,268
3 terraform-docs 4,007
4 go-recipes 3,807
5 kin-openapi 2,372
6 docuowl 1,269
7 huma 1,230
8 xc 986
9 doctree 860
10 namaste-go 72
11 go-redoc 60
12 go-notebook 38
13 spectest 36
14 jotbot 29
15 examples 28
16 instaunit 22
17 community 22
18 cobradoc 11
19 openapi-inline-examples 6
20 tblsrun 6
21 jsonata-playbook 5

Sponsored
SaaSHub - Software Alternatives and Reviews
SaaSHub helps you find the best software and product alternatives
www.saashub.com