Documentation Repository Structure Overview

The Coldtivate documentation is organized using MkDocs, with a clear, modular structure designed to help developers, contributors, and stakeholders navigate core concepts, self-hosting guides, technical features, and repository architecture. Below is an overview of the folder and file organization within the docs/ directory, highlighting the purpose of each section for easier onboarding and maintenance.

docs/
├── assets/               # Images or static assets used in documentation
├── contributing/         # Guidelines or templates for contributing to the project
├── core-concepts/        # Key architectural and functional concepts of the platform
├── self-hosting/         # Documentation for setting up and running the platform independently
├── index.md              # Main entry point for documentation homepage
├── .gitignore            # Git ignore rules for docs repo
├── .gitlab-ci.yml        # CI/CD configuration for building and deploying docs
├── LICENSE               # Licensing terms for the documentation
├── mkdocs.yml            # MkDocs configuration file (site structure, theme, nav)
├── Pipfile               # Pipenv dependency definitions for building docs
├── Pipfile.lock          # Lockfile ensuring consistent dependency versions
└── README.md             # Overview and instructions for contributing or building docs