Quickstart

Get this docs kit running on your machine, then deploy to aventr.

1. Prerequisites

• Python 3.11+
• tau CLI authenticated
• Cloud selected: aventr.cloud

2. Local preview

cd websites/tb_website_tmpl_docs_kit_web
python -m pip install -r requirements.txt
python -m mkdocs serve

Open http://127.0.0.1:8000.

3. Build exactly like the cloud

python -m mkdocs build --site-dir site
ls site

Cloud build copies site/ → /out.

4. Smoke the live APIs

curl healthcurl versionscurl feedback

curl -s https://gsoyhbbs0.gen.aventr.cloud/api/health

curl -s https://gsoyhbbs0.gen.aventr.cloud/api/versions | jq .

curl -s -X POST https://gsoyhbbs0.gen.aventr.cloud/api/feedback \
  -H 'content-type: application/json' \
  -d '{"name":"Ada","rating":5,"message":"Docs kit works","page":"/guides/quickstart/"}'

Definition of done

• Docs pages render with search + dark mode
• /api/health returns JSON
• Feedback appears in GET /api/feedback