Generated portal project structure - Fluid

The generated portal project combines a Portal Definition workspace with local preview tooling. This guide covers the files used for Portal Definition authoring. Each authored JSON file represents one PortalResource in the graph.

Definition files

Path	Purpose
`.fluidrc`	Links the project to a remote Portal Definition. Change it only when you intend to relink the project.
`portal/definition.json`	Stores top-level Portal Definition metadata.
`portal/screens/`	Stores one screen resource per JSON file.
`portal/navigations/`	Stores ordered web or mobile navigation resources.
`portal/profiles/`	Stores profile matching and navigation or theme assignments.
`portal/themes/`	Stores complete theme resources.
`.portal-sync/`	Stores tool-managed synchronization state. Never edit or commit it.

The file name is the resource slug. A display name inside the JSON does not replace that slug.

Project tooling

Path	Purpose
`package.json`	Defines the project scripts and dependency versions.
`vite.config.ts`	Installs the portal preview integration.
`tsconfig.json`	Configures TypeScript checks.
`.env.example`	Documents supported local environment variables without secrets.
`.env` and `.env.local`	Store local credentials and overrides. Never commit them.
`AGENTS.md`	Gives coding agents version-matched authoring instructions.

The installed package documentation matches the dependency versions in the project. Use it when local editor type information is unavailable. Company Widget Packages can also live in the generated project:

Path	Purpose
`src/widgets.config.ts`	Registers company-owned Widget Packages.
`src/widgets/`	Stores company widget source.
`.fluid/widget-dist/`	Contains generated publication artifacts. Do not edit or commit it.

These files belong to the company Widget Package workflow, not to the Portal Definition JSON contract.

Preserve generated state

Do not edit generated content to work around a failed command. Fix author-owned JSON or source, then regenerate. Preserve local changes before pull, clone, or recovery operations.