Project Structure
The landing app contains the navigation, marketing pages, and the standalone documentation routes.
The API docs page reads the local OpenAPI spec and renders endpoint summaries with JSON request and response examples.
- Keep shared UI in `src/app/componets`.
- Keep route-specific pages under `src/app/...`.
- Treat the API spec as the single source for backend endpoint details.
Local Development
Run the Next.js app on your local port and verify that the docs routes load before publishing changes.
Check the user docs, developer docs, and API docs separately so you catch broken route wiring early.
- Test `/userdoc/user-guide`, `/developerdoc/builder`, and `/api-docs/index.html`.
- Make sure locale routes under `/en` and `/de-DE` resolve to the same content family.
- Avoid introducing client-only randomness into server-rendered pages.
Build and Publish
The docs are rendered as normal Next.js pages, so publishing is the same as deploying the site.
When you update API behavior, update the OpenAPI source first and then verify the generated examples on the API docs page.
- Use the production build to catch route and metadata errors.
- Verify that the API docs still show request and response JSON after API changes.
- Remove obsolete content paths instead of redirecting them to a different doc family.
Content Conventions
Keep user docs focused on product usage and keep developer docs focused on integration and implementation details.
If a page needs examples, prefer short code snippets and JSON examples that match the live API schema.
- Use the user guide for workflows, permissions, and account setup.
- Use the developer guide for APIs, routes, and integration notes.
- Use the API docs for endpoint-level request and response payloads.