Documentation Structure

This part describes how documentation is structured.

Building Blocks

Doki server hosts one or more documentation projects. The projects are independent from each other. Each projects contain its own index and table of contents.

Inside each project, the documentation is organized in a tree-like structure. The main building block of documentation is a topic. Topics can have subtopics, subtopics can have their own subtopics, etc.

There are two types of topics:

• sections
• reference items

Sections can be arbitrarily organized in parts, chapters, sections, subsections, etc., they can contain other sections and reference items.

Reference items provide structured storage which is useful for source code documentation. The structure inside a reference item is strictly enforced. For example, classes can only contain properties, methods, events and fields and these child reference items are organized in automatically sorted lists. Standard sections are not supported inside reference items. Some reference items (e.g. Classes) support additional functionality such as inheritance tracking.