In-app user documentation
In-app user documentation
What this area does
The repository contains a dedicated documentation application under the /docs route. It is not just static markdown; it is a routed React experience with its own header, navigation, theme handling, and search.
Primary implementation
The main entrypoint is src/documentation/userdocumentation/UserDocumentation.jsx. Its layout composes:
HeaderLeftSidebarMainContentSearch- a marketing navigation strip reused from the home experience
- a theme provider for light/dark document styling
Section map
The docs site is organized into focused content families:
- Get started: introduction, overview, quickstart
- API: overview, reference, auth, documents, prompts, schemas, errors, rate limits
- Extraction guides: overview, file types, schemas, troubleshooting
- Logs: log structure and viewing logs
- Privacy / consent: consent and privacy docs, FAQ
- User auth: auth-related documentation
Layout and behavior
The docs shell has a few specific runtime behaviors:
- it toggles a menu overlay on small screens,
- it supports search across the navigation tree,
- it keeps theme state in a docs-local context,
- it still renders the marketing navigation to keep the public site entry points reachable.
Relationship to the rest of the app
This documentation site is exposed from the same router as the product and workspace pages, so it should be treated as a first-class route family rather than a side asset. If route names or page families change in the main app, the docs map should be checked at the same time.
Evidence-backed tests
The docs tree itself is primarily UI content, but the route behavior is exercised through the broader Playwright navigation workflows.