Matthew Toussain
823a80f663
* refactor(ui): share neutral capability contracts across editions Move SiriusCapability, SiriusPrincipal, the capability snapshot/provider types, and the Community catalog into a React-free contracts module so the browser registry and the incoming server registry cannot hold divergent catalogs. The UI extension modules re-export the same names, so consumers are unchanged. Pin the Community catalog to documentation/product/edition-boundary.yaml with a contract test, since that file is the source of truth for the edition boundary. Co-authored-by: mtoussain <mtoussain@gmail.com> * feat(ui): add server principal resolver and tRPC extension seam Mirror the browser extension registry on the server. A SiriusServerExtension declares tRPC namespaces with their required capabilities, at most one principal resolver, and optional session enrichers; registered.ts is the build-time overlay a private build replaces. protectedProcedure now enforces the capabilities declared for the procedure's namespace, so a contributed namespace is authorized without patching Core procedures. Principal resolution fails closed: a resolver that throws yields no principal instead of inheriting another edition's capability set. Community resolves any authenticated session to its static catalog, leaving Community behavior unchanged. root.ts cross-checks declared namespaces against the composed router in both directions, so an overlay that ships a router without declaring it (or declares a namespace it never serves) fails at startup rather than at request time. The routers stay object literals so tRPC keeps inferring client types. Co-authored-by: mtoussain <mtoussain@gmail.com> * test(ui): run extension contract tests in CI Add the server and capability suites alongside the UI registry suite behind a single test:extensions script, and make it a blocking CI step so the contracts private builds overlay are actually guarded. Co-authored-by: mtoussain <mtoussain@gmail.com> * docs: record the server-side extension seam in ADR-004 and the task board Co-authored-by: mtoussain <mtoussain@gmail.com> * fix(server): allow private principal resolver to replace Community fallback * test(server): prove private resolver can replace Community fallback * docs: record resolver replacement semantics and freeze server contracts at v1 Co-authored-by: mtoussain <mtoussain@gmail.com> * fix(server): split overlay router slot out of the declaration slot Contributing routers from registered.ts cycles: trpc.ts imports the registry to enforce capabilities, so an overlay router module importing createTRPCRouter loads while trpc.ts is still initializing and dies with 'Cannot access createTRPCRouter before initialization'. This was found by composing a private extension against the seam. Routers now come from registered-routers.ts, which only root.ts imports, so they load after trpc.ts is ready. root.ts still cross-checks declared namespaces against composed ones, and a contract test keeps the declaration modules free of tRPC imports. Co-authored-by: mtoussain <mtoussain@gmail.com> * docs: document the overlay module split and cycle constraint Co-authored-by: mtoussain <mtoussain@gmail.com> --------- Co-authored-by: Cursor Agent <cursoragent@cursor.com>
title, description, template, version, last_updated, author, tags, categories, difficulty, prerequisites, related_docs, dependencies, llm_context, search_keywords
| title | description | template | version | last_updated | author | tags | categories | difficulty | prerequisites | related_docs | dependencies | llm_context | search_keywords | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Documentation Index | Complete index of all documentation files in the Sirius project, organized by category and purpose | TEMPLATE.documentation-standard | 1.0.0 | 2026-02-22 | Development Team |
|
|
beginner | high |
|
Documentation Index
This document provides a complete index of all documentation files in the Sirius project, organized by category and purpose.
Core Documentation
System Documentation
- ABOUT.documentation.md - Documentation standards and system overview
- README.development.md - Development environment setup and workflow
- README.developer-guide.md - Comprehensive developer guide for Sirius project
- QUICK-REFERENCE.md - Quick reference guide for common operations
- QUICKREF.template-types.md - Quick reference for documentation template types
- README.logging-conventions.md - Structured logging conventions and standards
- README.sirius-event-log.md - Sirius event logging system and event management
- README.ui-style-guide.md - UI style guide and design system documentation
Contributing
- contributing.md - Complete guide for contributing to Sirius Scan, including development setup and workflows
- ABOUT.opensecurity-sirius-relationship.md - OpenSecurity sponsorship of SiriusScan and public-first commitment
Product
- edition-boundary.yaml - Community/Pro capability classification and edition boundary catalog
Architecture Documentation
System Architecture
- README.architecture.md - System architecture and component relationships
- README.architecture-quick-reference.md - Concise architectural overview for LLM context
- README.system-monitor.md - System monitoring architecture and implementation
- README.administrator.md - Administrator service architecture and design
- README.cicd.md - CI/CD pipeline architecture and workflows
- README.go-api-sdk.md - Go API SDK architecture, design patterns, and integration guide
- README.scanner-storage.md - Scanner Valkey schema contract for templates and NSE scripts
- README.auth-surface-matrix.md - Authentication and authorization policy matrix across API surfaces
- ADR.startup-secrets-model.md - Architectural decision record for installer-first startup and secrets model
- ADR.001-public-core-private-extension.md - Community as canonical public core; Pro as private extension consumer
- ADR.002-repository-ownership.md - SiriusScan public vs OpenSecurity-Infosec private repository ownership
- ADR.003-entitlement-model.md - Capability-based entitlements and signed offline licenses
- ADR.004-extension-contracts.md - Public API, UI, event, and engine extension contracts
- README.api-openapi-contract.md - Community
/api/v1OpenAPI contract, route classification, and CI drift checks - ADR.005-versioning-and-release-policy.md - SemVer, Pro/Core compatibility, and digest-pinned releases
- ARCHITECTURE.nse-repository-management.md - NSE repository management architecture
- README.docker-architecture.md - Comprehensive Docker setup and container architecture
- README.engine-component-pinning.md - Authoritative model for pinning engine submodules and CI build-arg overrides
Application Documentation
Agent System
- README.agent-system.md - Agent system architecture and design
- README.agent-template-api.md - API endpoints for managing agent vulnerability detection templates
- README.agent-template-ui.md - User interface workflows for managing agent templates
Scanner
- README.scanner.md - Scanner application documentation
- ARCHITECTURE.scanner-data-flow.md - End-to-end scanner data flow (UI → ValKey → persistence)
- ARCHITECTURE.sub-scans.md - Sub-scan architecture (network/agent, progress, cancellation)
- ARCHITECTURE.host-deduplication.md - Host deduplication and multi-source attribution
Operations Documentation
Git Operations
- README.git-operations.md - Git workflows and version control
- README.api-key-operations.md - API key lifecycle and incident recovery runbook
- README.release-closeout-v1.0.0.md - Final push, merge, and release acceptance evidence for Sirius v1.0.0
- README.maintainer-ops-issue-review.md - Label taxonomy, triage lifecycle, and ChatOps issue/PR review controls
Project Management
- README.new-project.md - New project development workflow and structure
- README.tasks.md - Task management system and project tracking
- startup-secrets-redesign-plan.md - Detailed implementation plan for startup and secrets redesign
- pro-bifurcation-plan.md - Implementation plan for the Community/Pro public-core, private-extension bifurcation
Deployment
- README.terraform-deployment.md - Terraform-based deployment processes
- README.docker-container-deployment.md - Docker container deployment using prebuilt registry images
- README.workflows.md - GitHub Actions workflow architecture and parallel build system
- README.community-independence.md - Community independence and private-leakage standing checks
SDK Management
- README.sdk-releases.md - SDK release process and dependency management
Testing Documentation
Testing Philosophy
- ABOUT.testing.md - Testing philosophy and approach for the Sirius project
Container Testing
- README.container-testing.md - Container testing system and validation
Documentation Testing
- README.documentation-testing.md - Documentation validation and linting
Testing Checklists
- CHECKLIST.testing-by-type.md - Issue-type-specific testing checklists for thorough validation
AI and Rules Documentation
AI Rules
- ABOUT.ai-rules.md - AI development rules and guidelines
- README.ai-identities.md - AI identity system and agent personas
- README.playwright.md - Playwright browser testing guide for automated testing and validation
Template Documentation
Documentation Templates
- TEMPLATE.about.md - Template for ABOUT documents
- TEMPLATE.api.md - Template for API documentation
- TEMPLATE.architecture.md - Template for architecture documentation
- TEMPLATE.custom.md - Template for custom documents
- TEMPLATE.documentation-standard.md - Standard documentation template
- TEMPLATE.guide.md - Template for step-by-step guides
- TEMPLATE.reference.md - Template for reference documentation
- TEMPLATE.template.md - Template for template documentation
- TEMPLATE.troubleshooting.md - Template for troubleshooting guides
Usage
This index serves as the central reference for all documentation in the Sirius project. Use it to:
- Find specific documentation by category or purpose
- Understand the documentation structure and organization
- Navigate between related documents using the links provided
- Ensure documentation completeness by checking against this index
Maintenance
This index should be updated whenever:
- New documentation files are added
- Documentation files are moved or renamed
- Documentation categories are reorganized
This document follows the Sirius Documentation Standard. For questions about documentation structure, see ABOUT.documentation.md.