OpenWiki quickstart

OpenWiki quickstart

This wiki explains the repository as a connected frontend system: one React app, several major product workflows, shared auth and API infrastructure, a public marketing site, an admin portal, and a focused test suite.

Start here

• Architecture overview
• Authentication and access control
• API client
• API endpoint catalog
• Consent and tenant services
• Schema generator workflow
• Prompt generator workflow
• Prompt library
• Admin portal
• Public marketing experience
• In-app user documentation
• Shared UI components
• Utilities and guardrails
• Test topology and validation
• Build, runtime, and deployment operations

High-level map

Runtime shells

• Public shell: marketing site and docs, owned by PublicLayout.
• Protected shell: app workspace with sidebar/topbar and route-level consent/auth gating, owned by App.jsx.
• Admin shell: gated operational portal, owned by AdminRoute and AdminLayout.

Major workflows

• AI Studio: AI Studio
• Processing Hub: Processing Hub
• Contract Analysis: Contract analysis
• Schema Generator: Schema generator workflow
• Prompt Generator: Prompt generator workflow
• Live Test: Live Test

Shared infrastructure

• Auth and tenant context: Authentication and access control and Consent and tenant services
• Network layer: API client and API endpoint catalog
• UI primitives: Shared UI components
• Security and helpers: Utilities and guardrails

Change-area routing table

Change intent	Read first	Owning source entrypoints	Narrow validation
Change app routing, shell composition, or top-level layout	Architecture overview	src/App.jsx, src/index.jsx, src/components/home/PublicLayout.jsx, src/admin/AdminRoute.jsx, src/admin/AdminLayout.jsx	Route/workflow Playwright spec for the affected area
Change login, token exchange, consent, or admin access	Authentication and access control	src/auth/index.js, src/auth/MsalAuthContext.jsx, src/contexts/AuthContext.jsx, src/services/consentService.js, src/services/tenantService.js, src/utils/rbac.js	tests/unit/rbac.test.js, tests/contract/client.test.js
Change API request behavior or shared HTTP rules	API client	src/services/api/client.js, src/services/api/endpoints.js	tests/contract/client.test.js
Change schemas or schema versioning	Schema generator workflow	src/pages/schemagenerator/*, src/services/api/schemaService.js	tests/contract/schemaService.test.js
Change prompts or prompt versioning	Prompt generator workflow and Prompt library	src/pages/promptgenerator/*, src/admin/availble_prompts/*, src/services/api/promptService.js	tests/contract/promptService.test.js
Change admin screens or admin access	Admin portal	src/admin/*, src/utils/rbac.js	tests/unit/rbac.test.js, relevant Playwright admin workflow
Change public marketing pages or docs	Public marketing experience and In-app user documentation	src/components/home/*, src/components/solutions/*, src/documentation/userdocumentation/*	affected Playwright navigation workflow
Change preview, upload, or shared chrome	Shared UI components	src/components/common/*, src/components/filepreview/*, src/components/sidebar/*, src/components/Topbar/*	focused component tests plus impacted workflow
Change utility behavior or security guardrails	Utilities and guardrails	src/utils/*, src/pages/livetest/utils/dataFiltering.js, src/utils/secureLogger.js	targeted unit test file

Quick navigation by subsystem

• Workspace shell and routing → Architecture overview
• Auth / consent / tenant → Authentication and access control
• API contracts → API client
• Schemas → Schema generator workflow
• Prompts → Prompt generator workflow and Prompt library
• Admin → Admin portal
• Public site → Public marketing experience
• Docs site → In-app user documentation
• Shared UI → Shared UI components
• Utilities → Utilities and guardrails
• Tests → Test topology and validation
• Operations → Build, runtime, and deployment operations

Backlog

• Deep backend behavior is intentionally out of scope for this frontend wiki. For server contracts, use the /docs/backend/ material that already exists in the repository.
• The repository contains many page families beyond the highest-rank workflows above. If you change a route family not listed here, add or expand the corresponding canonical page before shipping the change.