Uploaded image for project: 'Apache Avro'
  1. Apache Avro
  2. AVRO-2158

Modernize C# Documentation

    XMLWordPrintableJSON

    Details

    • Type: New Feature
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: csharp, doc
    • Labels:
      None

      Description

      I'd like to propose that we "modernize" the Avro C# documentation using DocFX. This is the closest thing that C# has to Javadoc. I threw together a quick example of what this would look like here: https://blachniet.github.io/avro-csharp-docs/api/Avro.html

      DocFX uses the triple-slash documentation in the C# code to generate API documentation. It also allows for conceptual documentation (getting started guides, tutorials, articles, etc.).

      If there is no opposition, I will pull together a legitimate solution (what I've got right now was thrown together in a few minutes).

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              blachniet Brian Lachniet
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: