Skip to content

node js api document should link to LTS release from each page #10726

Description

@toddself

The API documentation for the LTS stuff is a little hidden on the site -- you have to either know the LTS doc URL or always enter it from the front door, whereas nodejs.org/api is quite easy to remember.

It would be really nice if the documentation for the "live" release had a link on that page to the relevant documentation for the LTS version (if it exists).

The postgres documentation is actually an excellent example of this:
image

Each page has a link to various other supported (and even non-supported!) versions which makes it very easy to hop to the correct version that you're using.

Activity

  1. added
    docIssues and PRs related to Node.js documentation.
    feature requestIssues requesting new Node.js features.
    on Jan 10, 2017
  2. MylesBorins commented on Jan 10, 2017

    @MylesBorins
    Contributor

    This is a great idea! I've added the good first contribution tag

    /cc @nodejs/documentation

  3. benjamingr commented on Jan 10, 2017

    @benjamingr
    Member

    Sounds good to me +1

    Let's give new contributors a chance to write this and do this ourselves if no one steps up.

  4. sam-github commented on Jan 10, 2017

    @sam-github
    Contributor

    /cc @nodejs/website

  5. chris--young commented on Jan 10, 2017

    @chris--young

    I'll take a stab at this if that's alright. It'd probably be best to build it into doc/template.html right?

  6. 24 remaining items

  7. ghost added a commit that references this issue on Aug 30, 2017
  8. ghost added a commit that references this issue on Aug 30, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to Node.js documentation.feature requestIssues requesting new Node.js features.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions