go/doc: find a better home for Go documentation features like section headings #44194
Labels
Milestone
Comments
I'll highlight the current documentation at https://golang.org/pkg/go/doc/#ToHTML:
If we had documentation about writing documentation (similar to https://blog.golang.org/godoc, but as evergreen documentation rather than a blog post), I agree this should be covered there. I don't know if there are plans to do this at this time. CC @julieqiu, @stevetraut, @griesemer. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
fluhus/godoc-tricks describes several extended tricks for the Godoc renderer that remain relevant for https://pkg.go.dev. Particularly notable is the technique described as Titles, which can be thought of as naive section headings as demonstrated below with the word "Limitations":
To date this technique is not substantively mentioned in any of the following:
Considering its utility for information presentation, anchoring, etc., I propose the feature earn proper documentation. I tried to search for an existing bug for this, but the closest thing I could find was #18342. The correct approach would probably involve amending the previous documents somehow (or maybe another).
The text was updated successfully, but these errors were encountered: