docs

pixiray-ai/docs

The public documentation & knowledge site for Pixiray, served at docs.pixiray.ninja.

Built with MkDocs Material and deployed to GitHub Pages via the Deploy docs workflow on every push to main.

[!WARNING] This site is public. Never add internal, sensitive, or customer-specific content. Internal knowledge belongs in the private pixiray-ai/knowledge repo.

Local development

pip install -r requirements.txt
mkdocs serve      # http://127.0.0.1:8000

Structure

mkdocs.yml                 # site config + navigation
docs/
  index.md                 # landing page
  tooling/                 # dev environment & workflow guides
  engineering/             # technical write-ups, runbooks
  knowledge/               # public-safe shared knowledge

Adding a page

1. Add a Markdown file under docs/.
2. Register it in the nav: block in mkdocs.yml.
3. Open a PR — CI builds with mkdocs build --strict; merge to main publishes.

This site is open source. Improve this page.