💾 Archived View for godocs.io › - › about captured on 2024-02-05 at 09:11:54. Gemini links have been rewritten to link to archived content
⬅️ Previous capture (2023-12-28)
-=-=-=-=-=-=-
This is a fork of gddo, the software which previously powered the now-defunct godoc.org.
godocs.io generates documentation from Go source code. The guidelines for writing Go documentation apply.
Guidelines for documenting Go code
It's important to write a good summary of the package in the first sentence of the package comment. godocs.io indexes the first sentence and displays it in search results.
To add a package to godocs.io, search for the package by import path. If godocs.io does not already have the documentation for the package, it will fetch the package source code from the Go module proxy on the fly.
godocs.io checks for module updates periodically. You can force godocs.io to check for updates by clicking the refresh link at the bottom of the package documentation page. If that doesn't work, it's possible that the module proxy doesn't know about the update yet. You can try fetching the module with 'go get' to force the module proxy to check for updates.