[CDRIVER-3804] Provide link to API docs version list Created: 28/Sep/20 Updated: 01/Jan/24 |
|
| Status: | Backlog |
| Project: | C Driver |
| Component/s: | docs |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Task | Priority: | Minor - P4 |
| Reporter: | Christopher Cho | Assignee: | Unassigned |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | neweng | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||
| Epic Link: | DOCSP-29036 | ||||
| Description |
|
I am currently working on removing the API documentation version list from api.mongodb.com. I was unable to find any way to navigate to the current version list at http://mongoc.org/libmongoc/ nor navigate between versions when within the API documentation itself.
Could you create a page in the API documentation that links to the http://mongoc.org/libmongoc/ page or otherwise links to each version of the API?
This will help our users navigate to the appropriate versions of the API documentation.
|
| Comments |
| Comment by Christopher Cho [ 03/Apr/23 ] |
|
I no longer have access to update api.mongodb.com, but I think it could be a better UX for users to have a clear way to navigate between versions. If this is part of the plan in moving to Doxygen, feel free to mark this as a duplicate. Otherwise, I think it would still be good to consider as a future update since our other driver docs have a version selection function. |
| Comment by Christopher Cho [ 02/Oct/20 ] |
|
I think that would work as it provides some path to a list of the versions since the older versions feature a link in the butterbar to the current version. Ideally, at some point in the future, it would be awesome to have a version selector like the widget in the bottom right of Motor docs (https://motor.readthedocs.io/en/stable/) or a dropdown on the left nav like this one in the Ruby reference docs https://docs.mongodb.com/ruby-driver/current/
|
| Comment by Kevin Albertson [ 28/Sep/20 ] |
|
Certainly! To clarify, do you want a link to be added to the current version (http://mongoc.org/libmongoc/current/index.html) linking to to the page listing all versions (http://mongoc.org/libmongoc/)? |