Uploaded image for project: 'C++ Driver'
  1. C++ Driver
  2. CXX-2119

Reference documentation should be versioned

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Major - P3
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None

      Description

      The doxygen API documentation is available for all C++ driver releases:

      However, there is only one single current version of the reference documentation:

      This has the drawback that the current reference documentation needs to maintain instructions for older versions. In particular, the installation documentation maintains sections like "Configuring with mongocxx 3.1.x or 3.0.x", "Configuring with mongocxx 3.2.x or newer", "Configuring with mongocxx 3.5.0 or newer". New users would only need the newest instructions. I think it'd be preferable to maintain separate versions of the documentation, like:

      That way the latest instructions can remove the special cases for older versions of the driver.

        Attachments

          Activity

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            kevin.albertson Kevin Albertson
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated: