From e20d17ae3a567dc418334288f6c77dece92a4498 Mon Sep 17 00:00:00 2001
From: vgcman16 <155417613+vgcman16@users.noreply.github.com>
Date: Thu, 5 Jun 2025 20:59:02 -0500
Subject: [PATCH] docs: add mkdocs usage instructions

---
 docs/README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/docs/README.md b/docs/README.md
index e69de29b..ff0254ab 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -0,0 +1,31 @@
+# Documentation Overview
+
+This directory contains the sources used to generate the **bolt.diy** documentation site.
+It uses [MkDocs](https://www.mkdocs.org/) with the Material theme to build a static site from the files in [`docs/docs`](docs/docs).
+The build configuration lives in [`mkdocs.yml`](mkdocs.yml).
+
+## Building or Serving the Docs
+
+1. Install the documentation dependencies using [Poetry](https://python-poetry.org/):
+
+   ```bash
+   cd docs
+   poetry install
+   ```
+
+2. To preview the documentation locally, run:
+
+   ```bash
+   poetry run mkdocs serve -f mkdocs.yml
+   ```
+
+   This starts a local server and watches for changes.
+
+3. To generate the static site, run:
+
+   ```bash
+   poetry run mkdocs build -f mkdocs.yml
+   ```
+
+   The site will be output to the directory specified by `site_dir` in `mkdocs.yml` (currently `../site`).
+