How to document features in a NuGet package

This page summarizes the projects mentioned and recommended in the original post on /r/AskProgramming

InfluxDB - Power Real-Time Data Analytics at Scale
Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
www.influxdata.com
featured
SaaSHub - Software Alternatives and Reviews
SaaSHub helps you find the best software and product alternatives
www.saashub.com
featured
  • Sandcastle

    Sandcastle Help File Builder (SHFB). A standalone GUI, Visual Studio integration package, and MSBuild tasks providing full configuration and extensibility for building help files with the Sandcastle tools.

  • XmlDoc comments are the standard way to document C#. In your project settings you'll find an option to generate a documentation file. This option causes the compiler to join all the comments together into a single xml file. You'll want to include that file in your nuget packages because it'll be used to power IDE intellisense when someone installs the package. There are a variety of tools out there that will generate documentation websites from the xmldoc comments. It's been a few years since I used it but Sandcastle Help File Builder used to be my go-to. You can set up your CI pipeline to build and publish the documentation site just like it publishes the nuget package.

  • InfluxDB

    Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

    InfluxDB logo
NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts

  • Figma's Journey to TypeScript

    5 projects | news.ycombinator.com | 4 May 2024
  • AsciidocFX: The Asciidoc Editor for documentation and authoring

    3 projects | dev.to | 2 May 2024
  • Everything Curl

    3 projects | news.ycombinator.com | 29 Apr 2024
  • ELT as Compliance Enabler: Running Steampipe with Matillion Data Productivity Cloud

    1 project | dev.to | 25 Apr 2024
  • Creating Animated Diagrams for LinkedIn

    3 projects | dev.to | 22 Apr 2024