diff --git a/Codex/Portal/OVERVIEW.md b/Codex/Portal/OVERVIEW.md new file mode 100644 index 0000000..71f99d4 --- /dev/null +++ b/Codex/Portal/OVERVIEW.md @@ -0,0 +1,27 @@ +# Portal Overview + +Portal is the ZeroLagHub web frontend. It is the place customers use to sign in, manage servers, open consoles and files, launch the hosted IDE, view billing state, and complete account flows. + +Portal does not run game servers or agents itself. It presents state from the API, sends user actions to API routes, and turns backend responses into clear UI states, messages, and controls. + +## What Portal Does + +- Shows the main dashboard and server management views. +- Lets users create, start, stop, restart, and inspect servers through API-backed actions. +- Provides game server console access and sends console commands through the API. +- Provides game file and backup UI for listing, creating, restoring, and deleting backups. +- Launches the hosted IDE using API-issued URLs. +- Handles login, registration, forgot/reset password, onboarding, profile, billing, and suspension flows. +- Displays readiness, maintenance, operation-in-progress, and error states so users understand when an action is available or blocked. + +## What Portal Owns + +Portal owns the user experience around frontend state, forms, navigation, messages, disabled states, confirmation flows, and API integration from the browser. + +When backend state changes, Portal should make that state understandable and actionable without guessing at agent internals. + +## What Portal Does Not Own + +Portal does not own agent-local implementation, server orchestration, backup storage strategy, PBS or infrastructure design, billing provider internals, or API transport semantics. + +Those systems can affect Portal behavior, but their implementation details should live in their own docs unless a detail directly changes the frontend user experience.