Documentation Index
This index covers the public-facing documentation retained in the open-source repository.
Start Here
- overview/PRODUCT_OVERVIEW.md
- overview/SYSTEM_OVERVIEW.md
- getting-started/LOCAL_DEV_SETUP.md
- user-journeys/QUICK_START.md
- api/BUILD_API_GUIDE.md
Reading Path
flowchart TD
A[Documentation Index] --> B[Product Overview]
A --> C[System Overview]
A --> D[Local Development Setup]
A --> E[Role Quick Start]
A --> F[API Guide]
A --> G[Deeper Topic Sections]
G --> H[Operations]
G --> I[Architecture]
G --> J[Access And Journeys]
G --> K[Reference]
Core Product And Operations
- build-management/BUILD_MANAGEMENT_GUIDE.md
- kubernetes-integration/README.md
- overview/QUARANTINE_PROCESS_GUIDE.md
- overview/OPERATIONAL_CAPABILITIES_MATRIX.md
- authentication/OWNER_ADMIN_QUICK_START.md
- user-journeys/QUICK_START.md
Architecture
- architecture/REFERENCE_ARCHITECTURE.md
- architecture/WORKFLOW_ENGINE_ARCHITECTURE.md
- architecture/design/HEXAGONAL_ARCHITECTURE.md
- architecture/design/UNIFIED_MESSAGING_EVENT_CATALOG.md
- architecture/build/BUILD_DOMAIN_MODELS_ARCHITECTURE.md
- architecture/build/BUILD_METHODS_EXECUTION_ARCHITECTURE.md
- architecture/build/BUILD_DISPATCHER_DESIGN.md
- architecture/build/BUILD_TABLES_OVERVIEW.md
- architecture/security/ROLE_CONSOLIDATION_ARCHITECTURE.md
- architecture/security/ROLE_BASED_UI_ARCHITECTURE.md
Detailed Product And Operations
- build-management/BUILD_MANAGEMENT_DESIGN.md
- build-management/BUILD_SCHEMA_QUICK_REFERENCE.md
- build-management/BUILD_CONFIGURATION_STEP_DEEP_DIVE.md
- build-management/BUILD_MANAGEMENT_UI_UX_DESIGN.md
- kubernetes-integration/KUBERNETES_CLUSTER_CONNECTIVITY_GUIDE.md
- kubernetes-integration/HYBRID_INFRASTRUCTURE_STRATEGY.md
- kubernetes-integration/KUBERNETES_TEKTON_INTEGRATION.md
Access And User Journeys
- admin/ADMIN_PAGES_COMPLETE_GUIDE.md
- authentication/OWNER_ADMIN_QUICK_START.md
- authentication/OWNER_ADMIN_ROLE_CAPABILITIES.md
- authentication/OWNER_ADMIN_FEATURE_MATRIX.md
- authentication/RBAC-Permissions-Model.md
- authentication/RBAC-Quick-Reference.md
- user-journeys/INDEX.md
- user-journeys/QUICK_START.md
- user-journeys/ADMIN_JOURNEY.md
- user-journeys/OWNER_JOURNEY.md
- user-journeys/MEMBER_JOURNEY.md
- user-journeys/VIEWER_JOURNEY.md
- user-journeys/BUILD_PIPELINE_JOURNEY.md
- user-journeys/UNIFIED_MESSAGING_JOURNEY.md
API And Reference
- api/BUILD_API_GUIDE.md
- api/build-execution-openapi.yaml
- reference/Environment-File-Loading.md
- reference/EMAIL_TEMPLATE_SEEDER.md
- reference/LDAP_USER_SEEDING.md
- reference/MAKEFILE_COMMANDS.md
- reference/SYSTEM_CONFIGURATION_OPPORTUNITIES.md
- reference/USER_MANAGEMENT.md
Contributor And Process Reference
- reference/PULL_REQUEST.md
- reference/Pre-commit-Hook-Guide.md
- Other repository-maintenance notes under
reference/are intended primarily for contributors and maintainers.
Historical Or Deprecated Material
- kubernetes-integration/KUBERNETES_PROVIDER_MANAGEMENT.md is retained as historical background and is marked deprecated in the document.