[IGNITE-19328] .NET: Thin 3.0: Generate API documentation

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Done
• Affects Version/s: 3.0.0-beta1
• Fix Version/s: 3.0.0-beta2
• Component/s: platforms, thin client
• Labels: .NET ignite-3
• Ignite Flags: Docs Required, Release Notes Required
• Assignee: Pavel Tupitsyn
• Reporter: Pavel Tupitsyn
• Reviewer: Igor Sapego
• Created: 20/Apr/23 08:29
• Updated: 04/May/23 10:54
• Resolved: 04/May/23 10:54

Description

Generate API documentation with DocFX

• Install it as a local tool
• Update Gradle build to produce .NET docs along with Java docs on release
  • Integrate docfx with msbuild somehow?
• Somehow include extended LINQ documentation https://github.com/apache/ignite-3/blob/main/modules/platforms/dotnet/Apache.Ignite/Internal/Linq/README.md
• Think of a way to integrate a Getting Started section
• Think of a way to integrate Examples

Issue Links

• links to: GitHub Pull Request #2020
• links to: IGNITE-19328 .NET: Generate API documentation by ptupitsyn · Pull Request #2020 · apache/ignite-3