README.md

BBQS EMBER Documentation Web Application

This repo contains user documentation for the EMBER Archive.

The documentation site is built with Markdown and MkDocs. Documentation is written as a collection of markdown files, and MkDocs is used to render the documentation as a website.

Requirements

• uv. Installation instructions can be found here

Development

Edit Content

• Open the .md you'd like to edit
• Makes changes & save

Preview Changes

Run the following command:

uv run mkdocs serve

Then, open your browser to http://localhost:8080.

Contributing

Contibutions are welcome through pull requests. Please notify the BBQS EMBER team for review.