Skip to main content

​
Quick Start Guide

Get up and running with DotNetDocs documentation in just a few steps.
1

Install the Package

Install the DotNetDocs package from NuGet:
dotnet add packag eDotNetDocs.Tools
2

Add Using Statements

Import the namespaces you need:
using CloudNimble.DotNetDocs.Tests.Shared;
using CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios;
using CloudNimble.DotNetDocs.Tests.Shared.Parameters;
3

Create Your First Instance

Start using the library:
// Create a test base instance
var testBase = new DotNetDocsTestBase();

// Get assembly documentation
var assembly = testBase.GetTestsDotSharedAssembly();

// Work with sample classes
var sample = new SampleClass { Name = "My Sample" };

​
📦 What’s Included

  • DotNetDocsTestBase - Base class for documentation tests
  • SampleClass - Example class demonstrating basic patterns
  • Assembly utilities - Tools for working with assembly metadata
  • BaseClass & DerivedClass - Inheritance patterns
  • ClassWithProperties - Property documentation examples
  • ClassWithMethods - Method documentation patterns
  • DisposableClass - IDisposable implementation
  • ParameterVariations - Different parameter patterns
  • MixedAccessClass - Access modifier examples
  • Edge cases - Special documentation scenarios

​
🎯 Common Use Cases

public class MyApp
{
    public void BasicExample()
    {
        var sample = new SampleClass 
        { 
            Name = "Example" 
        };
        
        Console.WriteLine($"Sample: {sample.Name}");
    }
}

​
🔍 Explore the API

Browse Namespaces

Explore the namespace hierarchy

View Classes

See all available classes

Check Examples

Interactive code examples

Read Guides

In-depth tutorials

​
💡 Best Practices

Always dispose of resources properly when working with IDisposable implementations.
Use the strongly-typed methods when available for better IntelliSense support and compile-time checking.
Check the EdgeCases namespace for examples of handling special scenarios.

​
🚀 Next Steps

Now that you have the basics, explore:
  1. API Reference - Complete API documentation
  2. Component Showcase - See advanced Mintlify features
  3. Best Practices Guide - Learn optimal patterns
Success! You’re ready to start using CloudNimble.DotNetDocs. Head to the API documentation to explore all available features.