You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: build a static docs site (MkDocs) from the existing docs/ tree #13
v1.4.1 reorganised the flat docs/ root into five thematic subdirectories (guides/, design/, budgets/, reference/, project/) plus a freshly-written docs/README.md index. Every markdown link resolves; structure is clean.
What we don't have: a rendered static site. GitHub renders Markdown one file at a time — navigation between docs/guides/OPERATIONS_GUIDE.md, docs/ops/cansat_standard.md, and docs/design/architecture.md requires clicking back and forward, and there's no search.
Why it matters
A handful of per-profile ops guides + 8 ADRs + 5 budget docs is the right size to start justifying a site. Competition judges and external reviewers expect a "Documentation" link that opens a searchable site, not a GitHub tree view.
Proposal — MkDocs + Material theme
Minimal setup:
mkdocs.yml # nav derived from existing docs/ tree
docs/ # already organised; no reorg needed
.github/workflows/ # publish to gh-pages on every push to master (see #5)
Nav structure (mirroring the index in docs/README.md):
Activity