Table of Contents
Tip

The docs as explained here are used in multiple projects, but documented only once for better maintenance. When applying this to other projects, remember that some things such as the name, repository, or paths are a bit different.

Document Code Namespaces

It's usually very helpful to document what a namespace does. Using the same mechanism with the uid: you can create markdown files which will show extensive instructions.

The way it's set up is as follows:

  1. We have a folder /api-docs/api/dot-net/ with sub folders
  2. These are included for augmentation in the api docs (see docfx.json in the override section)
  3. Files in this folder will not be included but will replace some of the generated content.
Warning

There is a bug in this system. If your markdown contains more than one --- (triple dash) it will break the docfx build.

So make sure you use 6 dashes instead for this, to not confuse the yaml-header parser. Use ------ instead of --- in these override markdown files.

See this issue for more information.


Main Author

Daniel Mettler, @iJungleboy [MS MVP, DNN & Oqtane Core Team]

Content Management Expert, Chief Architect of 2sxc and cre8magic.
Forged in the jungles of Indonesia, lives in Switzerland , loves DNN ☢️, Oqtane 🩸 & 2sxc 💜.

Microsoft MVP | LinkedIn | Discord: @iJungleboy | Twitter: @iJungleboy | Github: @iJungleboy

Edit this page