Skip to content

Move <Service> Overview sections into only the top level #549

Description

@jgeewax

Right now, the Overview sections appear on every page for the classes under that service:

Do you think it would make more sense to move these sections into the top levels only?

Thoughts?

Activity

  1. added
    type: questionRequest for information or clarification. Not an issue.
    on May 8, 2015
  2. added this to the Core Future milestone on May 8, 2015
  3. ryanseys commented on May 8, 2015

    @ryanseys
    Contributor

    I believe the reason for this is that they don't have to go to the overview page to get a general idea of what the API does. I think @stephenplusplus can speak more to this.

  4. stephenplusplus commented on May 8, 2015

    @stephenplusplus
    Contributor

    I'm down with this. Trying to be too helpful can sometimes be less helpful.

  5. jgeewax commented on May 8, 2015

    @jgeewax
    ContributorAuthor

    Seems to me that it's also taking up some pretty valuable screen real-estate...

    Do you guys have any ideas on how we could document the Getting Started (expandable thing) and the Overview in a way that:

    1. doesnt take up tons of screen real estate
    2. still is visible on all the pages

    ?

  6. stephenplusplus commented on May 8, 2015

    @stephenplusplus
    Contributor

    I think limiting to the top level page will help. It just makes sense that if someone is in the Datastore -> Transaction docs, they would think to go up a level to Datastore to learn more about Datastore.

    Doing this could even let us get rid of the "Overview" section, and just move its content to the JSdoc blocks for the modules.

    Using BigQuery's page as an example, it would look like:

    screen shot 2015-05-08 at 12 26 11 pm

  7. jgeewax commented on May 8, 2015

    @jgeewax
    ContributorAuthor

    👍

  8. ryanseys commented on May 8, 2015

    @ryanseys
    Contributor

    Yeah I agree, for a page like http://googlecloudplatform.github.io/gcloud-node/#/docs/master/datastore/dataset?method=save we don't really need all the overview. Distracts from the method-specific docs.

  9. added 2 commits that reference this issue on May 9, 2015
    3f079ac
    47bfb23
  10. added and removed
    type: questionRequest for information or clarification. Not an issue.
    on May 9, 2015
  11. changed the title [-]Move <Service> Overview sections into only the top level?[/-] [+]Move <Service> Overview sections into only the top level[/+] on May 9, 2015
  12. 20 remaining items

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

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions