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/tools/cmd/godoc: Provide a feedback link for documentation pages #11255

Open
ianlancetaylor opened this Issue Jun 17, 2015 · 4 comments

Comments

Projects
None yet
4 participants
@ianlancetaylor
Contributor

ianlancetaylor commented Jun 17, 2015

It might be useful for Go newbies if there were a feedback link on documentation pages. Systems like PHP permit people to add comments to every doc page, and those comments sometimes expand to be useful additions. That is problematic because it leads directly to spam, but a simpler possibility would be a direct link to the issue tracker.

Could we add something like this golang.org? To godoc.org? Do we want to?

@ianlancetaylor ianlancetaylor added this to the Unplanned milestone Jun 17, 2015

@josharian

This comment has been minimized.

Contributor

josharian commented Jun 17, 2015

Increased opportunities for feedback are definitely helpful. We already struggle a bit to keep questions and requests for help on the mailing list instead of the issue tracker, though, so if we do this, it'd be good to try to guide people to the right forum--suggestions for improvements here, questions there. The line is subtle, of course.

@dr2chase

This comment has been minimized.

Contributor

dr2chase commented Jun 17, 2015

Alternately, could each topic in the online spec be annotated with links to tutorial materials, blog posts, related FAQ entries, and recommended style? We'd want to be a little careful about ensuring that links don't get stale (perhaps we can automate that) but this might address some of the recent complaints. I am in the newbie category myself, and it does require a bit of by-hand navigation and hopping around.

@adg

This comment has been minimized.

Contributor

adg commented Jun 23, 2015

@dr2chase's suggestion is a good one. If we were able to cross-reference our various docs then we could more aggressively cross-link them.

@adg

This comment has been minimized.

Contributor

adg commented Jun 23, 2015

FWIW we once had feedback links on all golang.org pages and the signal to
noise ratio was very, very low.

On 18 June 2015 at 05:01, dr2chase notifications@github.com wrote:

Alternately, could each topic in the online spec be annotated with links
to tutorial materials, blog posts, related FAQ entries, and recommended
style? We'd want to be a little careful about ensuring that links don't get
stale (perhaps we can automate that) but this might address some of the
recent complaints. I am in the newbie category myself, and it does require
a bit of by-hand navigation and hopping around.


Reply to this email directly or view it on GitHub
#11255 (comment).

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