x/pkgsite: add link support for codewiki.google repos

[ethanalee-work]

Link CodeWiki repos on pkg.go.dev

Present a codewiki.google link on pkg.go.dev when the repo exists on codewiki.google.

[gabyhelp]

Related Issues

• x/pkgsite: support custom links #42968 (closed)
• x/pkgsite: replace links to godoc.org in x/* repos #42251 (closed)
• x/pkgsite: add golang.org/x subrepo page #47281 (closed)
• x/pkgsite: linking to module source code #40477 (closed)
• x/pkgsite: surface VCS clone path from the go-import meta tag #46243
• x/pkgsite: stdlib source links should point to source of truth #43180 (closed)

_{(Emoji vote if this was helpful or unhelpful; more detailed feedback welcome in this discussion.)}

[adonovan]

How can one tell whether a repo exists on codewiki.google, short of sending it a request?

Can you post examples of Go modules where you have found the AI-generated documentation to add significant value over the existing documentation and/or code? It seems relatively few repos are currently present in its index.

Also, in my perhaps unpopular opinion, although AI-generated documentation contains mostly true statements, it still lacks the clarity about hierarchy and organization that is so crucial in introductory documentation to ensure that novice readers are correctly oriented. I am sure it will improve, but at this moment I don't think we should be directing Go users to it.

[ethanalee-work]

How can one tell whether a repo exists on codewiki.google, short of sending it a request?

One is able to send a request to codewiki.google/_/exists/github.com/<owner>/<repo> to determine if the module has been ingested in CodeWiki.

Can you post examples of Go modules where you have found the AI-generated documentation to add significant value over the existing documentation and/or code? It seems relatively few repos are currently present in its index.

In my discussion with the CodeWiki team, it seems that there is work being done to onboard a significant number of repos soon. One example (by no means exhaustive) I found is https://codewiki.google/github.com/golang/groupcache. Content aside, I think that the output it provides has a diagram that gives a good high-level overview of the module and also a brief summary.

I also had an idea where if the CodeWiki link does not exist, then we could instead provide a link on pkgsite to request the repo be onboarded.

Also, in my perhaps unpopular opinion, although AI-generated documentation contains mostly true statements, it still lacks the clarity about hierarchy and organization that is so crucial in introductory documentation to ensure that novice readers are correctly oriented. I am sure it will improve, but at this moment I don't think we should be directing Go users to it.

Those are some valid concerns, but there's potential for pages such as CodeWiki to provide useful entrypoints for high level overview of modules. Currently the pkgsite documentation is a reflection of the documentation already available on a module's source (if any). There is some value in having a high-level overview done by CodeWiki that enhances the existing source (Github or otherwise) docs.