Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

x/pkgsite: documentation feedback - tracking issue #37819

Open
julieqiu opened this issue Mar 12, 2020 · 2 comments
Open

x/pkgsite: documentation feedback - tracking issue #37819

julieqiu opened this issue Mar 12, 2020 · 2 comments

Comments

@julieqiu
Copy link
Contributor

@julieqiu julieqiu commented Mar 12, 2020

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

Issues currently open on this topic are:

  • #37816: insert space after Example
  • #36808: add ability to link to package doc subheadings
  • #36865: examples missing playground links
  • #37232: support different GOOS/GOARCH values when displaying package documentation
  • #37520: example links do not open examples
  • #37291: example code should be displayed as package main when rendering
  • #38056: automatically link RFCs in package documentation
  • #38073: display table of contents in command documentation
  • #37863: missing source files listing
  • #38205: broken source links in autogenerated API docs
  • #38429: hyperlink does not inherit version
  • #38575: anchor links to package-scoped constants and variables appear off-screen
  • #37102: show the package version that introduced a change in documentation
  • #38613: type definition links are missing in v2 packages
  • #38699: const block comment not rendered in some cases
  • #39270: documentation misparsed as an anchor
  • #39529: missing documentation headings/anchors
  • #39907: leave a sample of values when trimming large string literals and composite literals
  • #39559, #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

@julieqiu julieqiu removed the Documentation label Mar 12, 2020
@julieqiu julieqiu changed the title pkg.go.dev: documentation rendering feedback -- tracking issue pkg.go.dev: documentation feedback -- tracking issue Mar 12, 2020
@julieqiu julieqiu changed the title pkg.go.dev: documentation feedback -- tracking issue pkg.go.dev: documentation feedback - tracking issue Mar 12, 2020
@benhoyt
Copy link
Contributor

@benhoyt benhoyt commented Mar 25, 2020

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

@julieqiu
Copy link
Contributor Author

@julieqiu julieqiu commented Mar 26, 2020

Yup - it's been added!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.