add overview graphic

pagasa-parser · Feb 13, 2024 · 6bb5101 · 6bb5101
1 parent 7280f31
commit 6bb5101
Show file tree

Hide file tree

Showing 6 changed files with 186 additions and 1 deletion.
diff --git a/docs/assets/README.md b/docs/assets/README.md
@@ -1,2 +1,7 @@
 # Assets
+
+## Diagrams.net files (.drawio)
 Export as SVG with 300% zoom and `100` border, embedded images, and embedded fonts.
+
+## Adobe Illustrator files (.ai)
+Export as SVG with `Responsive` and `Minify` options.
diff --git a/docs/assets/overview.svg b/docs/assets/overview.svg
diff --git a/docs/assets/cyclones.drawio → docs/assets/src/cyclones.drawio b/docs/assets/cyclones.drawio → docs/assets/src/cyclones.drawio
diff --git a/docs/assets/src/overview.drawio b/docs/assets/src/overview.drawio
diff --git a/docs/index.md b/docs/index.md
@@ -12,6 +12,8 @@ arises from the need to centralize and standardize the multitude of
 reports and systems used by Philippine government agencies for easy
 repackaging and distribution.
 
+![High level overview](./assets/overview.svg)
+
 ## Rationale
 
 As of writing (January 2024), there exists no standard specification for

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -34,7 +34,7 @@ extra:
 repo_name: pods
 repo_url: https://github.com/pagasa-parser/pods
 copyright: |
-  Copyright &copy; 2023&ndash;2024 Philippine Open Disaster Specification contributors. Published under the <a href="https://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA 4.0</a> license.
+  Copyright &copy; 2023&ndash;2024 Philippine Open Disaster Specification contributors. Published under the <a href="https://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA 4.0</a> license.<br/>Diagram icons from FontAwesome. Copyright &copy; 2023 <a href="https://fontawesome.com">Fonticons, Inc.</a> <a href="https://creativecommons.org/licenses/by/4.0/">CC BY 4.0</a>. 
 
 theme:
   name: material