Docs Architecture

Repository role

This repository is shared documentation infrastructure for Sicket.

It should contain:

• the checked-in OpenAPI specification
• API reference pages
• integration guides
• versioning and migration notes

It should not duplicate backend implementation detail that belongs in source code comments or tests.

Recommended ownership split

Backend agent

• endpoint accuracy
• request and response schemas
• auth and authorization notes
• OpenAPI updates when backend behavior changes

Frontend agent

• integration examples
• frontend usage notes
• dashboard-specific guidance
• docs UI/navigation/content improvements

Shared editing rule

Both agents can edit this repo, but they should avoid changing the same file concurrently when possible.

Preferred ownership:

• OpenAPI spec: backend-owned
• guides/examples/navigation: shared, usually frontend-led

Why this structure

This keeps the contract out of one large Markdown file and makes it easier to:

• version the API over time
• open selected endpoints to customers later
• keep external and internal integrations aligned