uto_manager/mkdocs.yml

274 lines
8.9 KiB
YAML

site_name: UTO Manager Documentation
site_description: >-
Flutter-Based Military Unit Task Organization Enterprise System —
U.S. Army 2026 Doctrine Cross-Platform Command & Control Application
site_author: UTO Manager Development Team
site_url: https://git.kellsupport.com/uto_manager/docs
repo_name: uto_manager
repo_url: https://git.kellsupport.com/uto_manager
edit_uri: edit/develop/docs/
copyright: Copyright © 2026 UTO Manager Development Team
# -----------------------------------------------------------------------------
# Theme
# -----------------------------------------------------------------------------
theme:
name: material
language: en
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: blue
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: indigo
accent: blue
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
icon:
repo: fontawesome/brands/git-alt
logo: material/army
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.expand
- navigation.path
- navigation.top
- navigation.footer
- navigation.indexes
- search.highlight
- search.share
- search.suggest
- content.code.copy
- content.code.annotate
- content.tabs.link
- content.tooltips
- toc.follow
# -----------------------------------------------------------------------------
# Plugins
# -----------------------------------------------------------------------------
plugins:
- search:
lang: en
- minify:
minify_html: true
# -----------------------------------------------------------------------------
# Markdown Extensions
# -----------------------------------------------------------------------------
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
permalink: true
title: On this page
- tables
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- 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.magiclink:
repo_url_shorthand: true
user: uto_manager
repo: uto_manager
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets:
auto_append:
- docs/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 JavaScript (MathJax for doctrinal formulas)
# -----------------------------------------------------------------------------
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
# -----------------------------------------------------------------------------
# Extra CSS
# -----------------------------------------------------------------------------
extra_css:
- stylesheets/extra.css
# -----------------------------------------------------------------------------
# Extra Variables
# -----------------------------------------------------------------------------
extra:
version:
provider: mike
social:
- icon: fontawesome/brands/git-alt
link: https://git.kellsupport.com/uto_manager
name: Source Repository
analytics:
feedback:
title: Was this page helpful?
ratings:
- icon: material/emoticon-happy-outline
name: This page was helpful
data: 1
note: Thanks for your feedback!
- icon: material/emoticon-sad-outline
name: This page could be improved
data: 0
note: Thanks for your feedback!
# -----------------------------------------------------------------------------
# Navigation
# -----------------------------------------------------------------------------
nav:
- Home: index.md
- User Guide:
- user-guide/index.md
- Getting Started:
- user-guide/getting-started/installation.md
- user-guide/getting-started/quick-start.md
- user-guide/getting-started/interface-overview.md
- Working with Templates:
- user-guide/templates/overview.md
- user-guide/templates/mbct.md
- user-guide/templates/sbct.md
- user-guide/templates/abct.md
- user-guide/templates/cab-heavy.md
- user-guide/templates/cab-light.md
- Canvas & Navigation:
- user-guide/canvas/pan-zoom.md
- user-guide/canvas/node-selection.md
- user-guide/canvas/drag-and-drop.md
- user-guide/canvas/keyboard-shortcuts.md
- Personnel Management:
- user-guide/personnel/assigning-soldiers.md
- user-guide/personnel/mos-reference.md
- user-guide/personnel/readiness-status.md
- Validation & Readiness:
- user-guide/validation/mtoe-validation.md
- user-guide/validation/finding-types.md
- user-guide/validation/resolving-findings.md
- Export & Import:
- user-guide/export/json-export.md
- user-guide/export/pdf-export.md
- user-guide/export/protobuf-export.md
- user-guide/export/import.md
- Platform-Specific Guides:
- user-guide/platforms/windows.md
- user-guide/platforms/web.md
- user-guide/platforms/android.md
- Developer Guide:
- developer-guide/index.md
- Architecture:
- developer-guide/architecture/overview.md
- developer-guide/architecture/clean-architecture.md
- developer-guide/architecture/state-management.md
- developer-guide/architecture/offline-first.md
- Domain Model:
- developer-guide/domain/entities.md
- developer-guide/domain/enums.md
- developer-guide/domain/repositories.md
- developer-guide/domain/mos-dictionary.md
- Canvas Engine:
- developer-guide/canvas/custom-painter.md
- developer-guide/canvas/viewport-culling.md
- developer-guide/canvas/reingold-tilford.md
- developer-guide/canvas/quadtree.md
- developer-guide/canvas/drag-drop-state-machine.md
- Symbology Engine:
- developer-guide/symbology/mil-std-2525d.md
- developer-guide/symbology/sidc-resolver.md
- developer-guide/symbology/web-pipeline.md
- developer-guide/symbology/native-pipeline.md
- developer-guide/symbology/lru-cache.md
- Database & Persistence:
- developer-guide/database/drift-schema.md
- developer-guide/database/daos.md
- developer-guide/database/migrations.md
- developer-guide/database/indexeddb-web.md
- Validation Engine:
- developer-guide/validation/mtoe-engine.md
- developer-guide/validation/validation-rules.md
- developer-guide/validation/isolate-architecture.md
- Export Engine:
- developer-guide/export/json-codec.md
- developer-guide/export/protobuf-schema.md
- developer-guide/export/pdf-renderer.md
- Performance:
- developer-guide/performance/repaint-boundaries.md
- developer-guide/performance/dart-isolates.md
- developer-guide/performance/benchmarks.md
- CI/CD:
- developer-guide/cicd/pipeline.md
- developer-guide/cicd/build-targets.md
- developer-guide/cicd/code-coverage.md
- Contributing:
- developer-guide/contributing/workflow.md
- developer-guide/contributing/coding-standards.md
- developer-guide/contributing/testing.md
- Doctrinal Reference:
- doctrinal-reference/index.md
- Force Structures:
- doctrinal-reference/force-structures/mbct.md
- doctrinal-reference/force-structures/sbct.md
- doctrinal-reference/force-structures/abct.md
- doctrinal-reference/force-structures/cab.md
- MOS Reference:
- doctrinal-reference/mos/infantry.md
- doctrinal-reference/mos/medical.md
- doctrinal-reference/mos/field-artillery.md
- doctrinal-reference/mos/signal.md
- doctrinal-reference/mos/cyber-ew.md
- doctrinal-reference/mos/aviation.md
- doctrinal-reference/mos/logistics.md
- doctrinal-reference/mos/engineer.md
- MIL-STD-2525D:
- doctrinal-reference/symbology/overview.md
- doctrinal-reference/symbology/sidc-codes.md
- doctrinal-reference/symbology/affiliation-frames.md
- doctrinal-reference/symbology/echelon-modifiers.md
- Release Notes:
- release-notes/index.md
- release-notes/v1.0.0.md