Skip to content

Add MkDocs Material documentation#95

Merged
ThomasHalwax merged 6 commits intomainfrom
feature/documentation
Feb 15, 2026
Merged

Add MkDocs Material documentation#95
ThomasHalwax merged 6 commits intomainfrom
feature/documentation

Conversation

@axel-krapotke
Copy link
Contributor

Summary

Adds a complete documentation setup using MkDocs with the Material theme.

Documentation structure (docs-src/)

  • Getting Started: Overview, installation, core concepts
  • Features: Military symbology, shapes, MGRS graticule, elevation data, tile services, collaboration
  • Integration: NIDO WebSocket API, live data sources (SSE)
  • Reference: Keyboard shortcuts, configuration

Content is derived from existing files in docs/ and specs/.

MkDocs Material theme

  • Dark/light mode toggle
  • Navigation tabs
  • Search with suggestions and highlighting
  • Code copy buttons
  • Edit-on-GitHub links
  • Indigo/cyan colour scheme

Cross-repo website trigger

docs-src/workflows/trigger-website.yml contains a GitHub Action that triggers the ODINv2.Website build on release. It should be placed at .github/workflows/trigger-website.yml (requires a token with workflow scope to push).

Requires: A repository secret WEBSITE_DISPATCH_TOKEN containing a PAT with repo scope for cross-repo dispatch.

Build locally

cd docs-src
pip install mkdocs-material
mkdocs build    # output in site/
mkdocs serve    # local dev server at http://localhost:8000

axel-krapotke and others added 6 commits February 15, 2026 14:53
- Add docs-src/ with MkDocs Material configuration and documentation pages
- Documentation covers: getting started, features, integration (NIDO API,
  live data sources), and reference
- Content derived from existing docs/ and specs/ directories
- Add GitHub Action to trigger website rebuild on release publication
- Cross-repo dispatch requires a PAT stored as WEBSITE_DISPATCH_TOKEN secret
This file should be placed at .github/workflows/trigger-website.yml
The OAuth token lacks workflow scope to push it directly.
@ThomasHalwax ThomasHalwax merged commit e16809e into main Feb 15, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants