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

Docs suggestion: auto-linking to source file position #1240

Open
metaleap opened this issue Jun 11, 2024 · 4 comments
Open

Docs suggestion: auto-linking to source file position #1240

metaleap opened this issue Jun 11, 2024 · 4 comments

Comments

@metaleap
Copy link
Contributor

metaleap commented Jun 11, 2024

Well I have no "vuepress" or Vue experience (or inclination =), so I'll make a mere feature suggestion instead of a PR:

One thing that can be really handy for the user/reader of generated Golang pkg docs (incl. all of std/*) is how every declaration being documented links to its source location in that pkg's repo. For example you read https://pkg.go.dev/[email protected]#Or and it links to https://cs.opensource.google/go/go/+/go1.22.4:src/cmp/cmp.go;l=63 (where one can then quickly skim the source for perhaps subtle details not being explicated in the doc texts, or look for a gotcha one ran into).

Well that might sound like a silly toyish "nice-to-have-but-not-gotta-have", except — main reason I suggest this here is actually for the many "Please document me!" occurrences remaining in the std reference pages 😁

Of course, it's nothing remotely critical or pressing — just posting it in case whoever's occasionally tinkering with the web/docs side of things might find it a curious convenience to hack into existence. Otherwise, might label it for a v1.0 or post-1.0 polishing phase; after all, I guess just for the sake of reference / docs lookup, many current Gerbil users are comfortable just keeping all of std readily at hand right in their editor..

@vyzo
Copy link
Collaborator

vyzo commented Jun 11, 2024

We are working on integrating sources and documentation, and making it indexed and accessible in an IDE environment and the web, come help us!

@vyzo
Copy link
Collaborator

vyzo commented Jun 11, 2024

Additional discussion and resources: start with the IDE issue (#1226), follow the links, come join us in the Gerbil Core channel in gitter/matrix space.

@metaleap
Copy link
Contributor Author

Already in the channel, not to worry, I joined on Saturday as meta_leap — dangit, time's flying, still catching up..

@vyzo
Copy link
Collaborator

vyzo commented Jun 11, 2024

Yes, i know! This is also for future reference and other interested gerbils!

We, (gerbilkind ;), think that integrated documentation is a very important subject.

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

No branches or pull requests

2 participants