Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Add "Report An Issue" action in developer documentation toc #411

Merged
merged 4 commits into from May 20, 2014

Conversation

Projects
None yet
3 participants
Contributor

saivann commented May 19, 2014

This adds a "Report An Issue" entry in devel docs table of content, so people reading the documentation can easily report any mistake / typo on GitHub anywhere on the page. If javascript is enabled, the GitHub issue description is automatically filled with current browser location url.

Edit: Thanks to @harding for suggesting GitHub REST API idea.

capture du 2014-05-19 12 03 54

Contributor

wbnns commented May 19, 2014

@saivann - great idea!

Contributor

harding commented May 19, 2014

@saivann I tested it, and it works well when I click the link normally. When I Ctrl-click (or third-mouse-button click) to open in a new tab, the URL isn't copied in the issue. Is that something which can be easily fixed or something which Javascript can't do easily?

Either way, a report-new-issue screen is opened, and this makes it easy for people to report issues, so LGTM as-is.

Contributor

saivann commented May 19, 2014

@gwb3 Thanks!
@harding Good catch, this should be fixed now.

Contributor

harding commented May 20, 2014

Tested again with open-new-tab and it works. LGTM. Thanks, @saivann!

Contributor

saivann commented May 20, 2014

Thanks! Merging this into the main pull req.

saivann added a commit that referenced this pull request May 20, 2014

Merge pull request #411 from bitcoin/devel-report
Add "Report An Issue" action in developer documentation toc

@saivann saivann merged commit b6a8926 into devel-docs May 20, 2014

@saivann saivann deleted the devel-report branch May 20, 2014

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