Skip to content

Install

Requirements

  • Node.js 20+
  • A checkout of dot-mi (or any tree that contains agents/, shared/, and setup.sh).
  • For Create agent in the UI: bash and an executable setup.sh at the dot-mi root (the API runs bash /path/to/dot-mi/setup.sh create-agent …).

Get the code

Clone the repository:

git clone https://github.com/PlebeiusGaragicus/pi-portal.git
cd pi-portal

Or, inside dot-mi, use the submodule:

git submodule update --init tools/pi-portal
cd tools/pi-portal

Dependencies

npm install

Local documentation (MkDocs)

To build the same site as GitHub Pages locally:

pip install mkdocs-material
mkdocs serve

Open the URL MkDocs prints (usually http://127.0.0.1:8000).

GitHub Pages

The workflow .github/workflows/docs.yml builds and deploys this site on pushes to main when docs/, mkdocs.yml, or the workflow file changes. In the GitHub repository Settings → Pages, set Build and deployment → Source to GitHub Actions (not “Deploy from a branch”).