Skip to content

Commit 555e2c4

Browse files
committed
docs(contribute): workflow is partial
1 parent bca5a46 commit 555e2c4

File tree

2 files changed

+43
-12
lines changed

2 files changed

+43
-12
lines changed

docs/modules/ROOT/pages/contribute.adoc

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,7 @@ It is intended to provide an overview of the codebase and the process of adding
77

88
The MrDocs codebase is divided into several modules:
99

10-
[mermaid]
11-
....
12-
graph TD
13-
CL[Command Line Arguments] --> P
14-
CF[Configuration File] --> P
15-
P[Options] --> E
16-
P --> CD
17-
P --> G
18-
CD[Compilation Database] --> E
19-
E[Extract Symbols] -->|Corpus| G
20-
G[Generator] --> D(Documentation)
21-
....
10+
include::partial$workflow.adoc[]
2211

2312
This section provides an overview of each module and how they interact with each other in the MrDocs codebase.
2413

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
[mermaid]
2+
....
3+
graph TD
4+
%% Define styles for visual clarity
5+
classDef input fill:#D1E8FF,stroke:#005CFF,stroke-width:2;
6+
classDef artifact fill:#FFF5D1,stroke:#FFA500,stroke-width:2;
7+
classDef output fill:#D1FFD1,stroke:#008000,stroke-width:2;
8+
9+
%% Define Inputs
10+
subgraph Inputs
11+
CF[Configuration File]
12+
CL[Command Line Arguments]
13+
end
14+
class CL,CF input
15+
16+
%% Define Artifacts
17+
subgraph Processes
18+
P[Configuration Options]
19+
CD[Compilation Database]
20+
C[Corpus]
21+
G[Generator]
22+
end
23+
class P artifact
24+
class CD,C,G artifact
25+
26+
%% Define Outputs
27+
subgraph Outputs
28+
D[Documentation]
29+
end
30+
class D output
31+
32+
%% Relationships
33+
CF -->|Define| P
34+
CL -->|Define| P
35+
P -->|Defines| CD
36+
CD -->|Extract Symbols| C
37+
C -->|Feeds| G
38+
G -->|Produces| D
39+
40+
%% Highlight dependencies for clarity
41+
P -->|Influences| G
42+
....

0 commit comments

Comments
 (0)