docs clean ups

Author: jeffkala

docs/admin/release_notes/index.md

@@ -0,0 +1,3 @@
+# Release Notes
+
+All the published release notes can be found via the navigation menu. All patch releases are included in the same minor release (e.g. `v1.2`) document.

docs/admin/release_notes/version_1.0.md

@@ -1,4 +1,4 @@
-# v0.0 Release Notes
+# v1.0 Release Notes
 
 First major release of jdiff. Upgrade docs and development environments to use 2025 best practices.
 

docs/user/architecture.md

@@ -1,6 +1,6 @@
 # Library Architecture
 
-| ![jdiff HLD](./images/hld-architecture.png) |
+| ![jdiff HLD](../images/hld-architecture.png) |
 |:---:|
 | **`jdiff` architecture** |
 

docs/user/lib_getting_started.md

@@ -53,7 +53,7 @@ Below are the names of checks provided by the library. These both describe the t
 
 ## Workflow
 
-| ![jdiff Workflow](./images/jdiff-workflow.png) |
+| ![jdiff Workflow](../images/jdiff-workflow.png) |
 |:---:|
 | **`jdiff` Workflow** |
 

mkdocs.yml

@@ -1,29 +1,141 @@
 ---
 dev_addr: "127.0.0.1:8001"
-edit_uri: "edit/docs"
-site_name: "jdiff Documentation"
+edit_uri: "edit/main/jdiff/docs"
+site_dir: "jdiff/static/jdiff/docs"
+site_name: "Jdiff Documentation"
 site_url: "https://jdiff.readthedocs.io/"
-site_dir: "jdiff/docs"
 repo_url: "https://github.com/networktocode-llc/jdiff"
-python:
-  install:
-    - requirements: "docs/requirements.txt"
+copyright: "Copyright © The Authors"
 theme:
-  name: "readthedocs"
+  name: "material"
   navigation_depth: 4
+  custom_dir: "docs/assets/overrides"
   hljs_languages:
-    - "django"
+    - "python"
     - "yaml"
+  features:
+    - "content.code.annotate"
+    - "content.code.copy"
+    - "content.tabs.link"
+    - "navigation.footer"
+    - "navigation.tabs"
+    - "navigation.tabs.sticky"
+    - "navigation.tracking"
+    - "search.highlight"
+    - "search.share"
+    - "search.suggest"
+  favicon: "assets/favicon.ico"
+  logo: "assets/networktocode_logo.svg"
+  palette:
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: "default"
+      primary: "black"
+      toggle:
+        icon: "material/weather-sunny"
+        name: "Switch to dark mode"
+
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: "slate"
+      primary: "black"
+      toggle:
+        icon: "material/weather-night"
+        name: "Switch to light mode"
+
+validation:
+  absolute_links: "warn"
+  anchors: "warn"
+  omitted_files: "warn"
+  unrecognized_links: "warn"
+
 extra_css:
-  - "extra.css"
+  - "assets/extra.css"
+
+extra:
+  generator: false
+  ntc_sponsor: true
+  social:
+    - icon: "fontawesome/solid/rss"
+      link: "https://blog.networktocode.com/"
+      name: "Network to Code Blog"
+    - icon: "fontawesome/brands/youtube"
+      link: "https://www.youtube.com/channel/UCwBh-dDdoqzxXKyvTw3BuTw"
+      name: "Network to Code Videos"
+    - icon: "fontawesome/brands/slack"
+      link: "https://www.networktocode.com/community/"
+      name: "Network to Code Community"
+    - icon: "fontawesome/brands/github"
+      link: "https://github.com/networktocode/"
+      name: "GitHub Organization"
+    - icon: "fontawesome/brands/twitter"
+      link: "https://twitter.com/networktocode"
+      name: "Network to Code Twitter"
 markdown_extensions:
+  - "markdown_version_annotations":
+      admonition_tag: "???"
   - "admonition"
-  - toc:
+  - "toc":
       permalink: true
+  - "attr_list"
+  - "markdown_data_tables":
+      base_path: "docs"
+  - "md_in_html"
+  - "pymdownx.details"
+  # Need pymdownx.emoji for Grid icon search
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+  - "pymdownx.highlight":
+      anchor_linenums: true
+  - "pymdownx.inlinehilite"
+  - "pymdownx.snippets"
+  - "pymdownx.superfences":
+      custom_fences:
+        - name: "mermaid"
+          class: "mermaid"
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - "pymdownx.tabbed":
+      "alternate_style": true
+  - "pymdownx.tilde"
+
+plugins:
+  - "search"
+  - "gen-files":
+      scripts:
+        - "docs/generate_code_reference_pages.py"
+  - "glightbox":
+      manual: true # See https://blueswen.github.io/mkdocs-glightbox/flexibility/enable-by-image-or-page/
+  - "section-index"
+  - "mkdocstrings":
+      default_handler: "python"
+      handlers:
+        python:
+          paths: ["."]
+          options:
+            heading_level: 1
+            show_root_heading: true
+            show_root_members_full_path: true
+            show_source: false
+
 nav:
-  - Introduction: "index.md"
-  - Usage: "usage.md"
-  - Architecture: "architecture.md"
-# Future docs
-# - Examples: "example.md"
-# - Development Environment: "development.md"
+  - Overview: "index.md"
+  - User Guide:
+      - Library Overview: "user/lib_overview.md"
+      - Getting Started: "user/lib_getting_started.md"
+      - Architecture Overview: "user/architecture.md"
+      - Usage: "user/usage.md"
+      - Frequently Asked Questions: "user/faq.md"
+  - Administrator Guide:
+      - Install and Configure: "admin/install.md"
+      - Upgrade: "admin/upgrade.md"
+      - Uninstall: "admin/uninstall.md"
+      - Release Notes:
+          - "admin/release_notes/index.md"
+          - v0.0: "admin/release_notes/version_0.0.md"
+          - v1.0: "admin/release_notes/version_1.0.md"
+  - Developer Guide:
+      - Extending the Library: "dev/extending.md"
+      - Contributing to the Library: "dev/contributing.md"
+      - Development Environment: "dev/dev_environment.md"
+      - Architecture Decisions: "dev/arch_decision.md"