Documentation

Overview

This project uses MkDocs with the Material theme to generate documentation from Markdown files.

Structure

The documentation is organized as follows:

server/
├── .github/
│   └── mkdocs.yml          # MkDocs configuration
└── docs/
    ├── index.md            # Home page
    ├── setup.md            # Installation guide
    ├── usage.md            # Usage instructions
    ├── contributing.md     # Contributing guidelines
    └── documentation.md    # This page

Configuration

The MkDocs configuration is located at .github/mkdocs.yml:

site_name: ConstructCloud server
site_url: https://ConstructCloud.github.io/server
repo_url: https://github.com/ConstructCloud/server
edit_uri: edit/master/docs/

theme:
  name: material

docs_dir: ../docs

nav:
  - ...

Adding New Pages

To add a new documentation page:

Create the Markdown file

Add your new file to the docs/ directory:

touch docs/new-page.md

Add the new page to the nav section in .github/mkdocs.yml:

nav:
  - ...
  - New Page: new-page.md

Build and preview

The documentation is automatically built and deployed via GitHub Actions when changes are pushed to the master branch.