Skip to content

Add "table of contents" for the landing pages with lots of content? #2110

Closed

Description

@jgeewax

Pages like the Datastore landing page (https://googlecloudplatform.github.io/google-cloud-node/#/docs/google-cloud/0.49.0/datastore) have a ton of useful content, but there's no quick way to navigate to each section (e.g., "I forgot how to do transactional stuff... I just want a reminder about those transaction things").

Can we add a TOC-type box (maybe like the one that shows the available methods) for these pages? For example (I could just click "Transactions" in the box)

image

(Though we may want to change some of the headings now that they're front-and-center).

Activity

  1. callmehiphop commented on Mar 20, 2017

    @callmehiphop
    Contributor

    I moved this to https://github.com/GoogleCloudPlatform/gcloud-common/issues/221 since I think some additional configurations will probably be needed unless we embed HTML directly in the JSDoc.

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

Metadata

Metadata

Assignees

Labels

api: datastoreIssues related to the Datastore API.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions