x/pkgsite: documentation feedback - tracking issue

[julieqiu]

This is an umbrella issue to keep track feedback specific to documentation rendering for pkg.go.dev.

Issues currently open on this topic are:

• go.dev: insert space after Example #37816: insert space after Example
• go.dev: include '¶' permalinks in all package doc subheadings #36808: add ability to link to package doc subheadings
• x/pkgsite: examples missing playground links #36865: examples missing playground links
• x/pkgsite: support different GOOS/GOARCH values when displaying package documentation #37232: support different GOOS/GOARCH values when displaying package documentation
• x/pkgsite: example links do not open examples #37520: example links do not open examples
• x/pkgsite: example code should be displayed as package main when rendering #37291: example code should be displayed as package main when rendering
• x/pkgsite: automatically link RFCs in package documentation #38056: automatically link RFCs in package documentation
• x/pkgsite: display table of contents (TOC) in command documentation #38073: display table of contents in command documentation
• x/pkgsite: missing source files listing #37863: missing source files listing
• x/pkgsite: broken source links in autogenerated API docs #38205: broken source links in autogenerated API docs
• x/pkgsite: hyperlink does not inherit version #38429: hyperlink does not inherit version
• x/pkgsite: anchor links to package-scoped constants and variables appear off-screen #38575: anchor links to package-scoped constants and variables appear off-screen
• x/pkgsite: show the version when a symbol was added to a package #37102: show the package version that introduced a change in documentation
• x/pkgsite: type definition links are missing in v2 packages #38613: type definition links are missing in v2 packages
• x/pkgsite: const block comment not rendered in some cases #38699: const block comment not rendered in some cases
• x/pkgsite: documentation misparsed as an anchor #39270: documentation misparsed as an anchor
• x/pkgsite: missing documentation headings/anchors #39529: missing documentation headings/anchors
• x/pkgsite/internal/fetch/dochtml/internal/render: leave a sample of values when trimming large string literals and composite literals #39907: leave a sample of values when trimming large string literals and composite literals
• proposal: x/pkgsite: new source meta tag #39559, x/pkgsite: new source meta tag fixes - tracking issue #39981: new source meta tag + features blocked by that implementation

At the moment, our priority is to work towards open sourcing (#36747) and to address design feedback with our UX team. This issue is currently used to track issues that users are running into, to make sure we address them later on.

/cc @dmitshur @jba @spf13 @fflewddur @Joanne881107

[benhoyt]

Can we add #37863 to this list -- the missing "Package Files" section? That's certainly a lack I've noticed a few times.

[julieqiu]

Yup - it's been added!

[julieqiu]

Closing in favor of milestone pkgsite/dochtml: https://github.com/golang/go/milestone/165.