Uploaded image for project: 'C# Driver'
  1. C# Driver
  2. CSHARP-4682

Investigate docfx as a replacement for Sandcastle

XMLWordPrintableJSON

    • Type: Icon: Task Task
    • Resolution: Duplicate
    • Priority: Icon: Unknown Unknown
    • None
    • Affects Version/s: None
    • Component/s: Docs
    • Hide

      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?

      Show
      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?

      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.

            Assignee:
            Unassigned Unassigned
            Reporter:
            james.kovacs@mongodb.com James Kovacs
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: