Skip to content

Commit 0e08458

Browse files
committed
docs(usage): include MrDocs workflow
1 parent 555e2c4 commit 0e08458

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/modules/ROOT/pages/usage.adoc

+22
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
= Basic Usage
22

3+
The diagram below illustrates the workflow of the MrDocs documentation tool.
4+
It shows how inputs are transformed step by step into the final documentation output.
5+
Each component in the diagram represents a distinct type of entity:
6+
7+
- **Inputs**: Provide the initial parameters and settings required to configure and run the tool.
8+
These include the <<config-file,configuration file>> and <<cli,command-line arguments>>.
9+
- **Processes**: Represent intermediary outputs or data generated during the workflow.
10+
- **Outputs**: The final product, in this case, the generated documentation.
11+
12+
include::partial$workflow.adoc[]
13+
14+
In summary:
15+
16+
* Begin by specifying the <<config-file,configuration file>> and <<cli,command-line arguments>> to set up the options. The configuration options affect all processes.
17+
* The configuration options define a <<compilation-database, Compilation Database>>. All symbols are extracted with Clang to generate a unified corpus of symbols with their corresponding xref:page$commands.adoc[documentation].
18+
* Finally, This corpus is then fed to a xref:page$generators.adoc[Generator] that produces the desired documentation.
19+
20+
For more details on each component, refer to the corresponding sections of this guide.
21+
22+
[#config-file]
323
== MrDocs configuration file
424

525
The `mrdocs.yml` configuration file contains information about the project.
@@ -30,6 +50,7 @@ The most important information is the `source-root` option, which determines the
3050

3151
The list of all available options can be found in the xref:config-file.adoc[] page.
3252

53+
[#cli]
3354
== MrDocs invocation
3455

3556
NOTE: For consistency, these instructions assume you have the `mrdocs` executable in PATH.
@@ -59,6 +80,7 @@ mrdocs path/to/mrdocs.yml --output=../docs/reference
5980

6081
NOTE: Except for the path to the `mrdocs.yml` file, all other relative paths are made absolute relative to the `mrdocs.yml` file.
6182

83+
[#compilation-database]
6284
=== Compilation databases
6385

6486
One way to simplify the documentation generation process is by using a `compile_commands.json` file generated by CMake to determine the source files to process and their compile options.

0 commit comments

Comments
 (0)