Skip to content

Move examples and docs out of the README, point to docs instead #672

Description

@jgeewax

We're seeing people using the README contents on NPM as a source of real documentation, and missing out on the bigger picture because they're not seeing all of the other pieces.

Any objections to removing the README example content (specific snippets for each service) and pointing to the gh-pages docs instead?

Activity

  1. stephenplusplus commented on Jun 22, 2015

    @stephenplusplus
    Contributor

    I think the readme's job is to quickly make the sell on why gcloud is awesome, and part of that is shoving in the potential user's face how easy it is to "..." as soon as you can. A user going to a readme to look for the link to further documentation is common practice, so I would rather solve how to get the user to see our API documentation links than have the readme completely cater to the user rather than the maybe-user.

    Since we already link to the docs at the top of the page and in each service's sub-section, is it possible to get opinions from the users who sourced this feedback to see what we could do better?

  2. jgeewax commented on Jun 22, 2015

    @jgeewax
    ContributorAuthor

    I'll have our UX guy share the results at the end, but it was super clear that the person just wasn't getting to the docs because they thought the README was all there was.

    Can we add "for more details on , check out the docs here: " right after the example sections?

    Our goal is to funnel people to the gh-pages site ASAP.

  3. stephenplusplus commented on Jun 22, 2015

    @stephenplusplus
    Contributor

    Were the participants of the study Node developers? We're super tuned in to the patterns of GitHub + npm + API docs, and how and when to use each resource.

    Can we add "for more details on , check out the docs here: " right after the example sections?

    👍

  4. jgeewax commented on Jun 22, 2015

    @jgeewax
    ContributorAuthor

    They were, but this one in particular was not SUPER experienced, I'd say a 5/10 Node dev.

  5. 4 remaining items

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

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions