UiASub Documentation

UiASub Wiki

Technical documentation, hardware guides, and operational notes for the UiASub project.

Website Docs K2 Zephyr Docs Topside Docs

Wiki Usage

• Navigate categories using the top menu.
• Search for specific commands, files, or notes.
• Edit content via the repository link in the header.

Documentation Categories

Website

Frontend & Content

Project structure, logic, PWA configuration, and content management.

Firmware

K2 Zephyr

Installation instructions and embedded development guides for Zephyr.

Systems

Topside

Subsystem references and operational documentation for the topside.

Editing the wiki

1

Install Dependencies

Install the MkDocs toolchain and required plugins using Python.

2

Serve Locally

Run the MkDocs development server with auto-reload enabled.

3

Build Output

Test the static build locally before deploying to production.

Install Dependencies

python3 -m pip install mkdocs mkdocs-material mkdocs-awesome-pages-plugin

Serve locally

mkdocs serve

Open the local preview at http://127.0.0.1:8000/.

Build Output

Test the static build locally before deploying to production.

mkdocs build

When pushing to github it automatically builds and releases the webpage.

Release

• Edit Markdown files within the docs/ directory.
• Update the .pages files to modify navigation.
• Click the repository icon in the header to edit directly in source control.
• Push to main; GitHub Actions will automatically build and deploy.

Framework

Built with Material for MkDocs.