From 17b0ce56c35d21a7863609b568176193e61c39bf Mon Sep 17 00:00:00 2001 From: Bryan White Date: Mon, 23 Oct 2023 17:41:48 +0200 Subject: [PATCH] doc: fix pkg README template --- docs/template/pkg/README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/template/pkg/README.md b/docs/template/pkg/README.md index c7f915e9a..44f41885a 100644 --- a/docs/template/pkg/README.md +++ b/docs/template/pkg/README.md @@ -1,6 +1,3 @@ -Certainly! I've added a section named "Architecture Diagrams" in the documentation template below: - -```markdown # Package [PackageName] > Brief one-liner or quote about what this package does. @@ -16,11 +13,21 @@ Provide a few sentences about the purpose and functionality of this package. Con Visual representations often make it easier to understand the design and flow of a package. Below are the architecture diagrams that explain the high-level structure and interactions in this package: -![Architecture Overview](./path-to-diagram1.png) +```mermaid +--- +title: Architecture Overview +--- +flowchart +``` > **Figure 1**: Brief description about what this diagram represents. -![Another Diagram](./path-to-diagram2.png) +```mermaid +--- +title: Another Diagram +--- +flowchart +``` > **Figure 2**: Brief description about what this other diagram represents.