Skip to content

[Documentation] Replace Graphviz DOT diagrams with D2 diagrams#1352

Open
Shakti Suman (quic-shaksuma) wants to merge 1 commit into
qualcomm:mainfrom
quic-shaksuma:add-d2-diagrams
Open

[Documentation] Replace Graphviz DOT diagrams with D2 diagrams#1352
Shakti Suman (quic-shaksuma) wants to merge 1 commit into
qualcomm:mainfrom
quic-shaksuma:add-d2-diagrams

Conversation

@quic-shaksuma

Copy link
Copy Markdown
Contributor

Migrate the ELD user guide diagrams from Graphviz DOT sources to D2 and wire the documentation build to render the new diagram format.

D2 provides a more expressive and maintainable diagram source than basic Graphviz DOT for these user-guide diagrams. It supports reusable imports and classes, centralized theme configuration, richer built-in styling, icons and image-backed nodes, animated or dashed connector styles, and concise syntax for mixed flow, state, component, adapter, callback, and hook concepts.

A common.d2 is added as a shared style library so diagrams use consistent colors, typography, node shapes, arrows, rounded corners, shadows, and animated hook flows.

Typst PDF workflow is updated to support auto PDF-safe SVG variant generation from any animated image source used for HTML docs.

Closes #1350

Migrate the ELD user guide diagrams from Graphviz DOT sources to D2 and
wire the documentation build to render the new diagram format.

D2 provides a more expressive and maintainable diagram source than basic
Graphviz DOT for these user-guide diagrams. It supports reusable imports and
classes, centralized theme configuration, richer built-in styling, icons and
image-backed nodes, animated or dashed connector styles, and concise syntax for
mixed flow, state, component, adapter, callback, and hook concepts.

A common.d2 is added as a shared style library so diagrams use consistent colors,
typography, node shapes, arrows, rounded corners, shadows, and animated hook flows.

Typst PDF workflow is updated to support auto PDF-safe SVG variant generation
from any animated image source used for HTML docs.

Closes qualcomm#1350

Signed-off-by: Shakti Suman <shaksuma@qti.qualcomm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Replace graphviz dot graphs with D2 diagrams

2 participants