Skip to content

docs(profile): add public architecture guides #5

Description

@ClaudiaFang

Context

The organization profile now describes public services while intentionally keeping source and infrastructure repositories private where security requires it.

We need a public, sanitized documentation layer that explains the engineering approach without exposing implementation details, privileged access, topology, inventories, or secrets.

Scope

  • Add a public architecture guide with high-level system and delivery diagrams.
  • Add an implementation guide covering IaC, CI/CD, observability, and AI workflow principles at a safe abstraction level.
  • Add a public service catalog with entry points and status links where appropriate.
  • Link these guides from the organization profile README.
  • Review all content for security-sensitive operational details before publishing.

Acceptance criteria

  • Documentation communicates the public-service / private-implementation boundary clearly.
  • Architecture diagrams contain no private network, host, credential, inventory, or internal service details.
  • Profile README links to the published guides.
  • Public services retain discoverable product and status links.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions