Skip to content

Make it easy to open a documentation bug (or fork docs) from the docs themselves #348

Description

@jgeewax

Related to googleapis/google-cloud-python#98

Can we add a button near "See version history" that is something like "Edit on GitHub" or "See something wrong? Report an issue!" or something like that?

It'd be nice to make it easy for external developers to give feedback (or improve) our documentation.

Activity

  1. stephenplusplus commented on Jan 15, 2015

    @stephenplusplus
    Contributor

    I like the "Report an Issue" option since our docs are inlined in the source code. I think it would be unexpected to have a user click "Edit the docs" and be taken to a .js file.

    We have the "Edit on GitHub" on the MD-generated pages: https://googlecloudplatform.github.io/gcloud-node/#/faq and https://googlecloudplatform.github.io/gcloud-node/#/troubleshooting. I'll follow the same convention regarding placement & style for the new button on the API doc pages.

  2. jgeewax commented on Jan 15, 2015

    @jgeewax
    ContributorAuthor

    SGTM 👍

  3. stephenplusplus commented on Jan 20, 2015

    @stephenplusplus
    Contributor

    PR sent: #356

  4. added this to the Core Stable milestone on Feb 2, 2015
  5. 26 remaining items

  6. added a commit that references this issue on Feb 5, 2026
  7. added a commit that references this issue on Feb 26, 2026
  8. added a commit that references this issue on Mar 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

🚨This issue needs some love.triage meI really want to be triaged.

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions