[CXX-2119] Reference documentation should be versioned Created: 09/Oct/20  Updated: 07/Feb/24

Status: Backlog
Project: C++ Driver
Component/s: Documentation
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Major - P3
Reporter: Kevin Albertson Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Epic Link: Reference Docs Improvements

 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.


Generated at Wed Feb 07 22:04:57 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.