To use this README.md file, replace XXX with the project's information.

---

Documentation for XXX

Welcome to the XXX Documentation repository! This repository contains the source files for the XXX docs site, built with MkDocs and Material for MkDocs.

It includes the documentation content, written in Markdown, along with related images and example code. The theme and framework configurations live in the XXX-mkdocs repository.

Repository Structure

├── .snippets/           # Code and text snippets referenced in docs
│   ├── code/            
│   └── text/     
├── images/              # Images used in docs
├── <section>/           # Top-level section folder (e.g., `node-operators`)
│   ├── nav.yml          # Navigation definition for this section
│   ├── index.md         # Section landing page
│   ├── <page>.md        # Documentation pages within this section
│   └── ...                    
├── .nav.yml             # Navigation definition for top-level sections
├── index.md             # Main landing page
├── README.md
└── variables.yml        # Reusable variables used in docs

Notes:

• Each section folder contains its Markdown pages, an index.md landing page, and a .nav.yml file defining page titles and their order.
• Snippets and images mirror the structure of the documentation, making it easy to reference them.

Run the Docs Locally

To preview the documentation site locally:

1. Clone the XXX-mkdocs theme repository:

   git clone https://github.com/papermoonio/XXX-mkdocs.git

2. Clone the XXX-docs repository and place it under the XXX-mkdocs directory:

   XXX-mkdocs
   └── XXX-docs

   git clone https://github.com/XXX/XXX-docs.git

3. Install dependencies:

   pip install -r requirements.txt

4. Serve the site:

   mkdocs serve

Open http://127.0.0.1:8000 in your browser to view the docs. Any changes to Markdown files, snippets, or images will automatically update in the local preview.

License

This project is licensed under the GPL-3.0 License.