-
Notifications
You must be signed in to change notification settings - Fork 6
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
pkg-doc auto-discovery #212
Comments
Edit: Mis-read the comment 🙈 |
Sorry, clarification: When you generate documentation with doc2go for example.com/foo/..., documentation for all types within foo/... will be in the same generated website, so it uses relative links for those. This issue is toying with the idea of auto-discovery on that end. |
Oh yes, I mis-read your first post (my turn 😄 ).
Standardization would be nice, however I think having enough people take interest into that will be challenging (especially when "simply" prefixing the import-path with pkg.go.dev works 99% of the time). I would be very interested for code editors to support this. In VSCode any "view doc" link (like the import path) points to pkg.go.dev. It would be interesting to know if the developers of the go extension might be interested by such a feature before implementing it. |
Agreed. I think it's a long shot to get any upstream support for this (once there's actually a proposal, that is). That said, even without standardization, I think this would be useful even if only doc2go supports it. |
The idea for this came from #73.
Go defines go-import meta tags for how to find a Go module, and go-source for how to link to the source code from pkg.go.dev if the host isn't a known host.
A similar go-doc tag could be standardized for alternative documentation sources used by the package, and could be used during cross-package linking. Even without support in the upstream pkgsite, this will be useful for users of doc2go to be able to specify where to find their static documentation.
All other details TBD.
The text was updated successfully, but these errors were encountered: