Support for Namespace documentation in the C# API retypeapp output about retype

[AndreyChechel]

Hi @ApolonTorq

Thanks for the nice suggestion and for providing information about NamespaceDoc type approach. We'll certainly try to come up with a process of Namespace documentation that would work with Retype seamlessly.

Meanwhile, it's possible to mimic the API folder structure within the input folder (where MD files are stored) and to place a MD file with a namespace description at a corresponding location. For example, consider the following structure:

retype.json

{
  "input": "./docs",
  "api": {
    "input": "./path/to/csharp/solution",
    "output": "./api"
  }
}

If the solution contains a Demo.Sample.Program type, the following output structure can be expected:

.retype
│   index.html
│
└───api
    └───demo
        └───sample
            └───program
                    index.html

So, in order to document the Sample namespace, the input folder structure should look like:

docs
│   index.md
│
└───api
    └───demo
            sample.md

The sample.md file will be compiled and emitted as .retype/api/demo/sample/index.html.

Hope that helps.

[ApolonTorq]

Yep, thanks! That works - in combination with order and label metadata to position and title the namespace docs section.