Skip to content

Document the freemium architecture and open-core repo split #17

Description

@PAMulligan

Description

Write the architecture doc that explains how Optia's freemium model works and, importantly, which parts are public and which are private. The public repo (this one) ships the extension and all free functionality plus the client side of licensing; a separate private repo holds the Stripe integration, license signing, and the AI proxy. Document the trust boundary and why the client can never self-grant Pro.

Why

The open-core split is the whole reason we can open source the free parts while keeping the paid logic invisible, so it needs to be written down clearly for future contributors and for your own future reference. A good doc also prevents accidental leaks (someone moving paid logic into the public repo) and makes the security model auditable.

Acceptance Criteria

  • Architecture doc added to docs/ with a diagram of extension, backend, Stripe, and OpenAI
  • Clearly lists what lives in the public repo vs the private backend repo
  • Explains the trust boundary: signed entitlements, server-side verification, client cannot mint Pro
  • Documents the public verification key bundling and rotation plan
  • Contributor note: never add paid/secret logic to the public repo
  • Links the private backend repo (once created by the owner) and its setup
  • README updated to describe the freemium model at a high level
  • CI passes

Resources

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions