8f36e81fe8
Apply small follow-up edits to the frontend documentation: the AGENTS index, the forms, react-components, and ui guides. Signed-off-by: Émile Ré <emile@probo.com>
5.3 KiB
5.3 KiB
AGENTS.md
Detailed guides for specific subsystems live in contrib/claude/:
contrib/claude/make.md— GNUmakefile targets, codegen, overridable variablescontrib/claude/api-surface.md— GraphQL / MCP / CLI / n8n sync rulescontrib/claude/go-style.md— Go project deps, style (declarations, calls, imports, errors, naming, logging, safe URL construction)contrib/claude/ts-style.md— TypeScript style (safe URL construction, non-Relay HTTP, file upload/download)contrib/claude/go-testing.md— Go test conventions (parallel, require vs assert, naming)contrib/claude/go-service.md— Go service orchestration (Run, graceful shutdown, crash propagation)contrib/claude/go-worker.md— Go worker pattern (poll-based, bounded concurrency, FOR UPDATE SKIP LOCKED)contrib/claude/httpclient.md— HTTP client (kit/httpclient, SSRF protection by default, connector wiring)contrib/claude/gid.md— Global identifiers (GID layout, TenantID, entity type registry)contrib/claude/coredata.md— Data access layer (Scoper, SQL patterns, filters, order fields, migrations)contrib/claude/logging.md— Structured logging (PII-free rules, field helpers, logger wiring)contrib/claude/graphql.md— Go GraphQL backend (gqlgen, @goModel, connection types, cursor pagination)contrib/claude/mcp.md— MCP API patterns (specification.yaml, mcpgen, resolvers, type helpers)contrib/claude/cli.md— CLI command patterns (cobra, huh prompts, pagination, output formatting)contrib/claude/authorization.md— IAM policy-based authorization (policies, conditions, roles, AuthorizationAttributer)contrib/claude/validation.md— Validation framework (fluent API, validators, error codes, propagation)contrib/claude/e2e.md— End-to-end testing (factory builders, RBAC tests, tenant isolation, assertions)contrib/claude/agent.md— Agent orchestration framework (tools, handoffs, execution)contrib/claude/app-arborescence.md— Frontend app folder layout (pages, routes at resource folders, loaders, skeletons, _components, _lib, _locales)contrib/claude/relay.md— Frontend Relay client (queries, fragments, mutations, pagination)contrib/claude/hooks.md— Custom hooks (_lib placement, awaitable useMutation primitive, auto error handling)contrib/claude/react-components.md— React component shape (file/export, props, configure vs data via hooks, naming/suffix taxonomy, error props)contrib/claude/ui.md— @probo/ui v2 kit (Base UI headless, Tailwind, tailwind-variants, flat folders, bundle-safe skeletons)contrib/claude/v2-tokens.md— v2 design tokens (color, typography, radius, shadow scales; native spacing)contrib/claude/forms.md— Frontend forms (Base UI Field/Form tiers, native vs zod vs react-hook-form, server errors)contrib/claude/routing.md— Frontend routing (@probo/routes, navigation, typed params, URL state, auth/protected routes)contrib/claude/state-management.md— Client state decision order (Relay, URL, local, context, zustand)contrib/claude/permissions.md— Permission-gated UI (canUpdate/canDelete permission(action:) fields)contrib/claude/error-handling.md— Frontend error handling (ErrorBoundary at any level, error/fallback props, async try/catch)contrib/claude/i18n.md— Frontend i18next (key-based translations, _locales/.json per routes.ts, Intl formatting)contrib/claude/config.md— Configuration propagation (all files to update when config changes)contrib/claude/file-naming.md— File naming conventions (template files, extensions)contrib/claude/prompt-style.md— Agent prompt template structure (role/task/instructions XML style)contrib/claude/prompt-style.md— Agent prompt template structure (role/task/instructions XML style)contrib/claude/commit.md— Commit message conventionscontrib/claude/license.md— ISC license header (all file types)contrib/claude/release/README.md— Release process (per-track version bump, changelog, tag, push)contrib/claude/sandbox.md— Lima sandbox environments (create, manage, access services)contrib/claude/n8n.md— n8n community node (resources, operations, GraphQL helpers)