Skip to content

Commit

Permalink
docs(contribute): workflow is partial
Browse files Browse the repository at this point in the history
  • Loading branch information
alandefreitas committed Nov 27, 2024
1 parent bca5a46 commit 555e2c4
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 12 deletions.
13 changes: 1 addition & 12 deletions docs/modules/ROOT/pages/contribute.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,7 @@ It is intended to provide an overview of the codebase and the process of adding

The MrDocs codebase is divided into several modules:

[mermaid]
....
graph TD
CL[Command Line Arguments] --> P
CF[Configuration File] --> P
P[Options] --> E
P --> CD
P --> G
CD[Compilation Database] --> E
E[Extract Symbols] -->|Corpus| G
G[Generator] --> D(Documentation)
....
include::partial$workflow.adoc[]

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

Expand Down
42 changes: 42 additions & 0 deletions docs/modules/ROOT/partials/workflow.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
[mermaid]
....
graph TD
%% Define styles for visual clarity
classDef input fill:#D1E8FF,stroke:#005CFF,stroke-width:2;
classDef artifact fill:#FFF5D1,stroke:#FFA500,stroke-width:2;
classDef output fill:#D1FFD1,stroke:#008000,stroke-width:2;
%% Define Inputs
subgraph Inputs
CF[Configuration File]
CL[Command Line Arguments]
end
class CL,CF input
%% Define Artifacts
subgraph Processes
P[Configuration Options]
CD[Compilation Database]
C[Corpus]
G[Generator]
end
class P artifact
class CD,C,G artifact
%% Define Outputs
subgraph Outputs
D[Documentation]
end
class D output
%% Relationships
CF -->|Define| P
CL -->|Define| P
P -->|Defines| CD
CD -->|Extract Symbols| C
C -->|Feeds| G
G -->|Produces| D
%% Highlight dependencies for clarity
P -->|Influences| G
....

0 comments on commit 555e2c4

Please sign in to comment.