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: document links extraction feature #60175

Open
seankhliao opened this issue May 13, 2023 · 2 comments
Open

x/pkgsite: document links extraction feature #60175

seankhliao opened this issue May 13, 2023 · 2 comments

Comments

@seankhliao
Copy link
Member

What is the URL of the page with the issue?

https://pkg.go.dev/modernc.org/fsm@v1.1.2

What did you do?

See a Links section in the package godoc https://gitlab.com/cznic/fsm/-/blob/v1.1.2/nfa.go#L20

What did you expect to see?

Links section in the rendered documentation

What did you see instead?

No links and no sidebar

Additional Info

This was reported in slack: https://gophers.slack.com/archives/C0166L4QGJV/p1682761965985609

CL 274958 added support for extracting links to show in the sidebar as part of #42968 .
But it's not really documented anywhere
and it silently drops the entire section if the format doesn't match

@gopherbot gopherbot added this to the Unreleased milestone May 13, 2023
@suzmue suzmue modified the milestones: Unreleased, pkgsite/later May 22, 2023
@dolmen
Copy link
Contributor

dolmen commented Jun 6, 2023

Here is the section of the documentation that should be enhanced: https://go.dev/doc/comment#links

@dolmen
Copy link
Contributor

dolmen commented Jun 6, 2023

@seankhliao The list of links should probably not be indented.

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

No branches or pull requests

5 participants