Prox OS Internal Docs
BusinessGovernance

Knowledge Base Strategy

Prox OS needs multiple knowledge surfaces because the audience changes:

Purpose

Prox OS needs multiple knowledge surfaces because the audience changes: founder, future team, AI agents, contributors, users, developers, operators, and public ecosystem partners do not need the same level of detail.

Layers

LayerAudienceSource of truthNotes
Internal Team Knowledge BaseFounder, trusted maintainers, scoped AI agentsGit repository docsStores structured decisions, role specs, ADR/RFC notes, AI decision summaries, runbooks, and operating models.
External Public DocsDevelopers, users, communityDocs app / public docsExplains app model, SDK direction, public roadmap, contribution paths, and safe platform concepts.
GitHub Repo WikiCommunity collaboratorsGitHub Wiki or DiscussionsGood for lightweight FAQ and community notes; not architecture source of truth.
Internal API DocsInternal systems, admin, ops, agent workersAPI docs behind Access or org auth when implementedMay include admin-only routes, scopes, and operational notes.
Public API DocsDeveloper ecosystemOpenAPI / Scalar generated from API contractsPublic API surface only, with examples and stable contract notes.
AI Control Plane RecordsMaintainers and AI workersdocs/development/ai-control-planeStores curated summaries, task graphs, run logs, integration reports, and prompt templates.

What Belongs In Repo Docs

  • Durable decisions.
  • Role specs.
  • Architecture boundaries.
  • Roadmap status.
  • Task graph templates.
  • Reusable prompts.
  • AI run summaries.
  • Public or sanitized operating notes.

What Does Not Belong In Repo Docs

  • Raw long chat transcripts.
  • Private prompt streams that contain sensitive context.
  • Secrets, tokens, account IDs, billing details, private financial records, or personal legal documents.
  • Unreviewed speculation presented as current capability.

Public vs Internal API Docs

Internal API docs may include admin routes, audit boundaries, and agent worker use cases. Public API docs should be generated from implemented OpenAPI contracts and should not expose internal control-plane routes before they are ready.

On this page