docs(docs): Update to use latest Cat-CI Docs and reduce replication

input-output-hk · Nov 3, 2023 · 08cc557 · 08cc557
1 parent f43fe65
commit 08cc557
Show file tree

Hide file tree

Showing 18 changed files with 32 additions and 362 deletions.
diff --git a/docs/Earthfile b/docs/Earthfile
@@ -5,10 +5,8 @@ VERSION 0.7
 
 # Copy all the source we need to build the docs
 src:
-    FROM github.com/input-output-hk/catalyst-ci/earthly/docs:feat/docs3+mkdocs-material
-
-    # Just copy the actual doc src here.
-    COPY --dir src includes macros overrides mkdocs.yml /docs
+    # Common src setup
+    DO github.com/input-output-hk/catalyst-ci/earthly/docs:feat/docs3+SRC
 
     # Now copy into that any artifacts we pull from the builds.
     COPY --dir ../+repo-docs/repo /docs/includes

diff --git a/docs/includes/abbreviations.md b/docs/includes/abbreviations.md
diff --git a/docs/includes/repo/CODE_OF_CONDUCT.md b/docs/includes/repo/CODE_OF_CONDUCT.md
diff --git a/docs/includes/repo/CONTRIBUTING.md b/docs/includes/repo/CONTRIBUTING.md
diff --git a/docs/includes/repo/LICENSE-APACHE b/docs/includes/repo/LICENSE-APACHE
diff --git a/docs/includes/repo/LICENSE-MIT b/docs/includes/repo/LICENSE-MIT
diff --git a/docs/includes/repo/README.md b/docs/includes/repo/README.md
diff --git a/docs/includes/repo/SECURITY.md b/docs/includes/repo/SECURITY.md
diff --git a/docs/macros/__init__.py b/docs/macros/__init__.py
diff --git a/docs/macros/include.py b/docs/macros/include.py
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -1,152 +1,40 @@
+INHERIT: std-theme.yml
+
+# cspell: words cips
+
 # Project Information
 site_name: Project Catalyst - Catalyst Voices
 site_url: https://input-output-hk.github.io/catalyst-docs
-site_author: The Project Catalyst Team
-copyright: (c) 2023 Input Output Global
-
-# cspell: words Diagramsnet, pymdownx, linenums, inlinehilite, superfences,
-# cspell: words tasklist, betterem, materialx, twemoji, smartsymbols,
-# cspell: words kroki, excalidraw, glightbox, cips, pygments, arithmatex
 
 # Repository
 repo_name: input-output-hk/catalyst-voices
 repo_url: https://github.com/input-output-hk/catalyst-voices
 
-# The Documentation src to build.
-docs_dir: src
-
-theme:
-  name: material
-  custom_dir: overrides
-  palette:
-    # Palette toggle for light mode
-    - scheme: default
-      media: "(prefers-color-scheme: light)"
-      toggle:
-        icon: material/brightness-7
-        name: Switch to dark mode
-
-    # Palette toggle for dark mode
-    - scheme: slate
-      media: "(prefers-color-scheme: dark)"
-      toggle:
-        icon: material/brightness-4
-        name: Switch to light mode
-
-  features:
-    - navigation.instant
-    - navigation.instant.progress
-    - navigation.tracking
-    #- navigation.tabs
-    #- navigation.tabs.sticky
-    - navigation.sections
-    - navigation.expand
-    - navigation.path
-    - navigation.indexes
-    - toc.follow
-    - toc.integrate
-    - search.suggest
-    - search.highlight
-
-plugins:
-  - search
-  - meta-manager
-  - macros:
-      module_name: macros
-  # - diagrams - Plugin is installed, but produces corrupted output
-  - kroki:
-      ServerURL: https://kroki.io
-      EnableDiagramsnet: true
-      HttpMethod: POST
-  - glightbox
-
-markdown_extensions:
-  # Python Markdown
-  - abbr
-  - admonition
-  - attr_list
-  - def_list
-  - footnotes
-  - md_in_html
-  - tables
-  - toc:
-      permalink: true
-
-  # Python Markdown Extensions
-  - pymdownx.arithmatex:
-      generic: true
-  - pymdownx.betterem:
-      smart_enable: all
-  - pymdownx.caret
-  - pymdownx.details
-  - pymdownx.emoji:
-      emoji_index: !!python/name:material.extensions.emoji.twemoji
-      emoji_generator: !!python/name:material.extensions.emoji.to_svg
-  - pymdownx.highlight:
-      anchor_linenums: true
-      line_spans: __span
-      pygments_lang_class: true
-  - pymdownx.inlinehilite
-  - pymdownx.keys
-  - pymdownx.mark
-  - pymdownx.smartsymbols
-  - pymdownx.snippets:
-      auto_append:
-        - includes/abbreviations.md
-  - pymdownx.superfences:
-      custom_fences:
-        - name: mermaid
-          class: mermaid
-          format: !!python/name:pymdownx.superfences.fence_code_format
-  - pymdownx.tabbed:
-      alternate_style: true
-  - pymdownx.tasklist:
-      custom_checkbox: true
-  - pymdownx.tilde
-
-extra:
-  consent:
-    title: Cookie consent
-    description: >-
-
-      We use cookies to recognize your repeated visits and preferences, as well
-      as to measure the effectiveness of our documentation and whether users
-      find what they're searching for. With your consent, you're helping us to
-      make our documentation better.
-
 # Page tree
 nav:
-  - Home:
-      - Home: index.md
-      - Getting Started:
-          - Getting Started: getting-started/index.md
-          - Quick Start: getting-started/quick-start.md
-          - Advanced: getting-started/advanced.md
-          - Development: getting-started/development.md
-      - Monorepo Architecture:
-          - Monorepo Architecture: monorepo-architecture/index.md
-      - Catalyst Standards:
-          - Catalyst Standards: catalyst-standards/index.md
-          - Draft CIPs:
-              - Draft CIPs: catalyst-standards/draft-cips/index.md
-              - Role Registration: catalyst-standards/draft-cips/role-registration/cip-xxxx.md
-              - RBAC CIP30 Extension: catalyst-standards/draft-cips/rbac-cip30-extension/cip-xxxx.md
-              - Catalyst Voting CIP30 Extension: catalyst-standards/draft-cips/catalyst-vote-signing-cip30-extension/cip-xxxx.md
-          - Catalyst Ballot Formats:
-              - Catalyst Ballot Formats: catalyst-standards/ballot/index.md
-              - Catalyst V1 Ballot: catalyst-standards/ballot/catalyst-v1.md
-              - Catalyst V2 Ballot: catalyst-standards/ballot/catalyst-v2.md
-      - Appendix:
-          - Documentation Examples:
-              - Examples: appendix/examples/index.md
-              - Abbreviations: appendix/examples/abbreviations.md
-              - Admonitions: appendix/examples/admonitions.md
-              - Code Formatting: appendix/examples/code-formatting.md
-              - Mermaid Diagrams: appendix/examples/mermaid-diagrams.md
-              - Kroki Diagrams: appendix/examples/kroki-diagrams.md
-          - Important Information:
-              - Important Information: appendix/important/index.md
-              - Contributing: appendix/important/contributing.md
-              - Code of Conduct: appendix/important/coc.md
-              - Security: appendix/important/security.md
-              - License: appendix/important/license.md
+  - Home: index.md
+  - Getting Started:
+      - Getting Started: getting-started/index.md
+      - Quick Start: getting-started/quick-start.md
+      - Advanced: getting-started/advanced.md
+      - Development: getting-started/development.md
+  - Monorepo Architecture:
+      - Monorepo Architecture: monorepo-architecture/index.md
+  - Catalyst Standards:
+      - Catalyst Standards: catalyst-standards/index.md
+      - Draft CIPs:
+          - Draft CIPs: catalyst-standards/draft-cips/index.md
+          - Role Registration: catalyst-standards/draft-cips/role-registration/cip-xxxx.md
+          - RBAC CIP30 Extension: catalyst-standards/draft-cips/rbac-cip30-extension/cip-xxxx.md
+          - Catalyst Voting CIP30 Extension: catalyst-standards/draft-cips/catalyst-vote-signing-cip30-extension/cip-xxxx.md
+      - Catalyst Ballot Formats:
+          - Catalyst Ballot Formats: catalyst-standards/ballot/index.md
+          - Catalyst V1 Ballot: catalyst-standards/ballot/catalyst-v1.md
+          - Catalyst V2 Ballot: catalyst-standards/ballot/catalyst-v2.md
+  - Appendix:
+      - Important Information:
+          - Important Information: appendix/important/index.md
+          - Contributing: appendix/important/contributing.md
+          - Code of Conduct: appendix/important/coc.md
+          - Security: appendix/important/security.md
+          - License: appendix/important/license.md
diff --git a/docs/overrides/cip.html b/docs/overrides/cip.html
diff --git a/docs/src/appendix/examples/abbreviations.md b/docs/src/appendix/examples/abbreviations.md
diff --git a/docs/src/appendix/examples/admonitions.md b/docs/src/appendix/examples/admonitions.md
diff --git a/docs/src/appendix/examples/code-formatting.md b/docs/src/appendix/examples/code-formatting.md
diff --git a/docs/src/appendix/examples/index.md b/docs/src/appendix/examples/index.md