Developer Guide

This section is for engineers integrating with SynckHub and Common.

It is contract-first: use specs and stable endpoint families, not reverse-engineered behavior or UI scraping.

What this section covers

• architecture boundaries and local dev flow
• auth and error model
• Common control-plane API families
• SynckHub platform API families
• uploads, shared links, and coauthoring endpoints
• federation API surfaces
• public share infra routing with a version-controlled frontend map
• current product areas that matter to integrators: routing, authz, audit, connected accounts, folder-backed entities, and structured workflows

Recommended reading path

1. start-here/architecture-and-specs.md
2. start-here/local-development.md
3. api/authentication-and-error-model.md
4. api/common-control-plane-api.md
5. api/synckhub-platform-api.md
6. api/uploads-shared-links-and-coauthoring.md
7. api/federation-apis.md
8. guides/public-share-infra-routing.md

Working stance

Use the public docs here to orient yourself, then go to the authoritative contracts:

• synckhub/docs/platform/*.md
• common-control-plane/docs/openapi/v1.yaml
• synckhub/docs/openapi/ai-v1.json where applicable

The platform is broad now. The only sane integration strategy is to respect service boundaries.