SOP - Assembly

Documentation site built with MkDocs and the Material theme.

Primary repo content lives under docs/sop/ and docs/LEV Part Glossary.md.

Quick Start

Prerequisites

• Python 3.8+
• pip

Setup

1. Clone the repository

   git clone https://github.com/ovesorg/sop-assembly.git
   cd sop-assembly

2. Install dependencies

   pip install -r requirements.txt

3. Serve locally

   mkdocs serve

   Documentation will be available at http://127.0.0.1:8000

Build

To build the static site:

mkdocs build --clean

Output will be in the site/ directory.

Project Structure

.
├── docs/              # Documentation source files
├── overrides/         # Theme customization
│   ├── javascripts/   # Custom JavaScript
│   ├── partials/      # Template overrides
│   └── stylesheets/   # Custom CSS
├── mkdocs.yml         # MkDocs configuration
├── requirements.txt   # Python dependencies
└── README.md          # This file

Utilities

KRR (Kill, Rebuild, Restart)

Clean rebuild and restart the documentation server:

mkdocs-oves-krr

Contributing

1. Edit Markdown files in docs/
2. Update mkdocs.yml for navigation changes
3. Test locally with mkdocs serve
4. Commit and push changes

Support

For issues or questions, please open an issue in this repository.

---

📚 For detailed documentation, visit: docs.omnivoltaic.com/sop-assembly