This repository contains the user documentation for Decode Orc.

Built with MkDocs and Material for MkDocs.

The documentation is available at: https://simoninns.github.io/decode-orc-docs/

Simply add or edit markdown files in the docs/ folder. The navigation sidebar is automatically generated from the folder structure.

• Place files in docs/ or organized subdirectories
• Navigation is auto-generated from folder structure
• Use .pages files to customize ordering (optional)

1. Enter development shell:

   nix develop

2. Run local development server:

   mkdocs serve

   Open http://127.0.0.1:8000 in your browser. Changes to markdown files will auto-reload.

3. Build static site:

   nix build
   # Output in ./result/

If you prefer not to use Nix, you can set up the development environment using pip:

1. Create a virtual environment (recommended):

   python3 -m venv venv
   source venv/bin/activate  # On Linux/macOS
   # or on Windows: venv\Scripts\activate

2. Install dependencies:

   pip install -r requirements.txt

3. Run local development server:

   mkdocs serve

   Open http://127.0.0.1:8000 in your browser. Changes to markdown files will auto-reload.

4. Build static site:

   mkdocs build
   # Output in ./site/

Documentation is automatically deployed to GitHub Pages when changes are pushed to the main branch via GitHub Actions.

No manual build or deployment steps needed!