Building with an AI agent? Point it here
These guides are served as a public, no-auth API so a coding assistant can read them on demand. Start it at the self-describing entry point — /api/v1/dev-guide/capabilities — which lists every endpoint: the guide index (/docs), the raw markdown of any guide (/docs/{slug}), full-text search, and the design tokens.css. A one-line nudge in your repo’s AGENTS.md — “fetch /api/v1/dev-guide/capabilitiesand read the relevant guides before writing code” — keeps it working from the current conventions.Foundations
Add observability to your app
How to wire up logs and container metrics for your app on the platform — Loki via stdout, and Prometheus via the podman exporter.
Foundations
Adding portal auth to your app
Wire your app's request handlers up to the portal's JWT auth — install the library, verify tokens, declare roles, and run it locally end-to-end.
Foundations
Creating a new app
The standard repo shape for a new internal tool — Next.js frontend and FastAPI backend co-located in one repo, why that shape suits agent-driven development, and the path from empty repo to deployed behind the portal.
Foundations
External apps & links
Register tiles the portal doesn't proxy — apps that sign in directly against our Authentik (like ExcaliDash), and plain third-party bookmarks (GitHub, Atlassian, Miro, AWS SSO).
Conventions
Just recipes
Every Shyft project ships the same set of just recipe names so contributors can move between repos without re-learning the commands.
Foundations
Portal registration
Register a new app with the portal admin UI: walk through every form field, pick the right Base URL for your topology, and verify the proxy can reach you.