[CSHARP-4682] Investigate docfx as a replacement for Sandcastle Created: 20/Jun/23  Updated: 12/Sep/23  Resolved: 12/Sep/23

Status: Closed
Project: C# Driver
Component/s: Docs
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Unknown
Reporter: James Kovacs Assignee: Unassigned
Resolution: Duplicate Votes: 0
Labels: green-build-friday
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Duplicate
duplicates CSHARP-4783 API docs generating with docfx Closed
Documentation Changes Summary:

1. What would you like to communicate to the user about this feature?
2. Would you like the user to see examples of the syntax and/or executable code and its output?
3. Which versions of the driver/connector does this apply to?


 Description   

We use Sandcastle to generate API ref docs for the .NET/C# Driver. It is no longer supported or maintained by Microsoft. The MSI package will only install on Windows and is becoming increasingly difficult to install on newer versions of Windows.

DocFX is suggested as a replacement for API ref docs generation. We should investigate whether this can be a simple drop-in replacement for Sandcastle.


Generated at Wed Feb 07 21:49:01 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.