The documentation system for Carbon closely matches with the moduler nature
of the build system. There are three levels to documentation, a root level,
a module level and a sub-module level. The root level documents resides within
the {build-home}/doc-build
directory. The module level documents
lie withing a "docs" directory within a module directory
({build-home}/modules/{module-name}/docs
). The sub-module documents
lie within a directory inside the module level directories.
Documentation Structure
+ {build-home}
|-+ doc-build
|-+ modules
|-+ core
| |-+ docs
| |-+ component
| |-+ config
| |-+ exception
|-+ cache
|-+ docs