Uploaded image for project: 'Couchbase node.js Client Library'
  1. Couchbase node.js Client Library
  2. JSCBC-1148

Improve API Reference with descriptive text and structure

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Unresolved
    • Major
    • 4.x
    • None
    • docs
    • None
    • 0

    Description

      Our current API Reference uses TypeDoc like many other projects do.  Unlike other projects though, we do not have any introductory text and our descriptions, while accurate, are not very accessible.  

       

      For example, this is our current API ref homepage:
      https://docs.couchbase.com/sdk-api/couchbase-node-client/modules.html

       

       

      Note there is no descriptive text, no overview of the classes/modules.  

       

      Even if, as a user, I know to look to the Cluster class, I don't get much more and it's the same for Scope and Collection:
      https://docs.couchbase.com/sdk-api/couchbase-node-client/classes/Cluster.html

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          People

            jared.casey Jared Casey
            ingenthr Matt Ingenthron
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty