Merge pull request #4660 from Incognito/patch-1

Docs: Corrects name of C4 link
mermaid-js · Jul 25, 2023 · db9051b · db9051b
2 parents 9347353 + 91ae9a2
commit db9051b
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 7 deletions.
diff --git a/docs/syntax/c4c.md → docs/syntax/c4.md b/docs/syntax/c4c.md → docs/syntax/c4.md
@@ -2,13 +2,13 @@
 >
 > ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
 >
-> ## Please edit the corresponding file in [/packages/mermaid/src/docs/syntax/c4c.md](../../packages/mermaid/src/docs/syntax/c4c.md).
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/syntax/c4.md](../../packages/mermaid/src/docs/syntax/c4.md).
 
 # C4 Diagrams
 
 > C4 Diagram: This is an experimental diagram for now. The syntax and properties can change in future releases. Proper documentation will be provided when the syntax is stable.
 
-Mermaid's c4 diagram syntax is compatible with plantUML. See example below:
+Mermaid's C4 diagram syntax is compatible with plantUML. See example below:
 
 ```mermaid-example
     C4Context
@@ -114,7 +114,7 @@ For an example, see the source code demos/index.html
 - Dynamic diagram (C4Dynamic)
 - Deployment diagram (C4Deployment)
 
-Please refer to the linked document [C4-PlantUML syntax](https://github.com/plantuml-stdlib/C4-PlantUML/blob/master/README.md) for how to write the c4 diagram.
+Please refer to the linked document [C4-PlantUML syntax](https://github.com/plantuml-stdlib/C4-PlantUML/blob/master/README.md) for how to write the C4 diagram.
 
 C4 diagram is fixed style, such as css color, so different css is not provided under different skins.
 updateElementStyle and UpdateElementStyle are written in the diagram last part. updateElementStyle is inconsistent with the original definition and updates the style of the relationship, including the offset of the text label relative to the original position.

diff --git a/packages/mermaid/src/docs/.vitepress/config.ts b/packages/mermaid/src/docs/.vitepress/config.ts
@@ -134,7 +134,7 @@ function sidebarSyntax() {
         { text: 'Quadrant Chart', link: '/syntax/quadrantChart' },
         { text: 'Requirement Diagram', link: '/syntax/requirementDiagram' },
         { text: 'Gitgraph (Git) Diagram 🔥', link: '/syntax/gitgraph' },
-        { text: 'C4C Diagram (Context) Diagram 🦺⚠️', link: '/syntax/c4c' },
+        { text: 'C4 Diagram 🦺⚠️', link: '/syntax/c4' },
         { text: 'Mindmaps 🔥', link: '/syntax/mindmap' },
         { text: 'Timeline 🔥', link: '/syntax/timeline' },
         { text: 'Zenuml 🔥', link: '/syntax/zenuml' },

diff --git a/packages/mermaid/src/docs/.vitepress/theme/redirect.ts b/packages/mermaid/src/docs/.vitepress/theme/redirect.ts
@@ -28,7 +28,7 @@ const idRedirectMap: Record<string, string> = {
   '8.6.0_docs': '',
   accessibility: 'config/theming',
   breakingchanges: '',
-  c4c: 'syntax/c4c',
+  c4c: 'syntax/c4',
   classdiagram: 'syntax/classDiagram',
   configuration: 'config/configuration',
   demos: 'ecosystem/integrations',
@@ -70,6 +70,7 @@ const idRedirectMap: Record<string, string> = {
 
 const urlRedirectMap: Record<string, string> = {
   '/misc/faq.html': 'configure/faq.html',
+  '/syntax/c4c.html': 'syntax/c4.html',
 };
 
 /**

diff --git a/packages/mermaid/src/docs/syntax/c4c.md → packages/mermaid/src/docs/syntax/c4.md b/packages/mermaid/src/docs/syntax/c4c.md → packages/mermaid/src/docs/syntax/c4.md
@@ -2,7 +2,7 @@
 
 > C4 Diagram: This is an experimental diagram for now. The syntax and properties can change in future releases. Proper documentation will be provided when the syntax is stable.
 
-Mermaid's c4 diagram syntax is compatible with plantUML. See example below:
+Mermaid's C4 diagram syntax is compatible with plantUML. See example below:
 
 ```mermaid-example
     C4Context
@@ -61,7 +61,7 @@ For an example, see the source code demos/index.html
 - Dynamic diagram (C4Dynamic)
 - Deployment diagram (C4Deployment)
 
-Please refer to the linked document [C4-PlantUML syntax](https://github.com/plantuml-stdlib/C4-PlantUML/blob/master/README.md) for how to write the c4 diagram.
+Please refer to the linked document [C4-PlantUML syntax](https://github.com/plantuml-stdlib/C4-PlantUML/blob/master/README.md) for how to write the C4 diagram.
 
 C4 diagram is fixed style, such as css color, so different css is not provided under different skins.
 updateElementStyle and UpdateElementStyle are written in the diagram last part. updateElementStyle is inconsistent with the original definition and updates the style of the relationship, including the offset of the text label relative to the original position.