diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 4b3d40a8..3e92be62 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -27,7 +27,7 @@ jobs: - name: Install and Deploy working-directory: apps/docs run: | - pip install mkdocs-material + pip install -r requirements.txt git config user.name github-actions[bot] git config user.email 41898282+github-actions[bot]@users.noreply.github.com mkdocs gh-deploy --force \ No newline at end of file diff --git a/README.md b/README.md index 5466ac6b..8f193f2b 100644 --- a/README.md +++ b/README.md @@ -149,6 +149,10 @@ Before running RowBoat, ensure you have: } ``` +6. **Documentation** + + The documentation site is available at [http://localhost:8000](http://localhost:8000) + ## Troubleshooting 1. **MongoDB Connection Issues** diff --git a/apps/docs/Dockerfile b/apps/docs/Dockerfile new file mode 100644 index 00000000..f1773211 --- /dev/null +++ b/apps/docs/Dockerfile @@ -0,0 +1,11 @@ +FROM python:3.12 + +WORKDIR /app + +COPY requirements.txt . + +RUN pip install -r requirements.txt + +COPY . . + +CMD ["mkdocs", "serve", "--dev-addr", "0.0.0.0:8000"] \ No newline at end of file diff --git a/apps/docs/docs/index.md b/apps/docs/docs/index.md index 000ea345..70989ded 100644 --- a/apps/docs/docs/index.md +++ b/apps/docs/docs/index.md @@ -1,17 +1,5 @@ -# Welcome to MkDocs +# Welcome to Rowboat -For full documentation visit [mkdocs.org](https://www.mkdocs.org). +Welcome to the official documentation for Rowboat. Rowboat is an open-source project that helps you build, test, and deploy AI applications. -## Commands - -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. - -## Project layout - - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +You can find the source code on GitHub at [@rowboatlabs/rowboat](https://github.com/rowboatlabs/rowboat/). diff --git a/apps/docs/readme.md b/apps/docs/readme.md new file mode 100644 index 00000000..2783c518 --- /dev/null +++ b/apps/docs/readme.md @@ -0,0 +1,55 @@ +# Documentation Site + +This documentation site is built using [MkDocs Material](https://squidfunk.github.io/mkdocs-material/), a modern documentation framework that creates beautiful and functional static sites. + +## Prerequisites + +- Python 3.x +- pip (Python package manager) + +## Setup + +Install the required dependencies: + +```bash +pip install -r requirements.txt +``` + +## Development + +To run the documentation site locally: + +```bash +mkdocs serve +``` + +This will start a local server, and you can view the documentation site at `http://localhost:8000`. + +### Building the static site + +To build the static site: + +```bash +mkdocs build +``` + +This will generate the static site in the `site` directory. + +### Project structure + +- `mkdocs.yml`: The main configuration file for MkDocs. +- `docs/`: The directory containing the Markdown files for the documentation. +- `site/`: The directory generated by the `mkdocs build` command, containing the static site files. + +## Writing Documentation + +- Documentation files are written in Markdown format +- Place new documentation files in the `docs` directory +- Update `mkdocs.yml` to include new pages in the navigation + +## Additional Resources + +- [Mkdocs documentation](https://www.mkdocs.org/getting-started/) +- [MkDocs Material Documentation](https://squidfunk.github.io/mkdocs-material/getting-started/) +- [Markdown Guide](https://www.markdownguide.org/basic-syntax/) + diff --git a/docker-compose.yml b/docker-compose.yml index bc09183c..9d008800 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -41,4 +41,12 @@ services: - "3002:3002" environment: - OPENAI_API_KEY=${OPENAI_API_KEY} - restart: unless-stopped \ No newline at end of file + restart: unless-stopped + + docs: + build: + context: ./apps/docs + dockerfile: Dockerfile + ports: + - "8000:8000" + restart: unless-stopped