Skip to content

[AISOS-2174] docs: add architecture diagram [testing ticket 2158]#153

Open
ekuris-redhat wants to merge 1 commit into
forge-sdlc:mainfrom
ekuris-redhat:forge/aisos-2174
Open

[AISOS-2174] docs: add architecture diagram [testing ticket 2158]#153
ekuris-redhat wants to merge 1 commit into
forge-sdlc:mainfrom
ekuris-redhat:forge/aisos-2174

Conversation

@ekuris-redhat

@ekuris-redhat ekuris-redhat commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator

Summary

This pull request introduces the comprehensive, unified system architecture specification for the AISOS (AI Software Development Lifecycle Orchestrator) platform, creating a single source of truth for its distributed pipeline components. By codifying these complex pipelines into version-controlled documentation, we ensure deep technical alignment across development squads, streamline onboarding, and provide clear operational boundaries for automated agents and human-in-the-loop interactions.

Changes

Documentation Architecture

  • Created the unified architecture specification file at docs/architecture.md containing five native Mermaid flowcharts covering the end-to-end integration pipeline (Ingestion, Routing, Sandboxed Execution, CI/CD Gate, and Human-in-the-Loop Feedback loops).
  • Defined a complete, production-ready JSON Schema for the Ingestion Payload (covering both Jira Webhook structures and Redis Queue message payloads).
  • Formulated an Ingestion & State Resolution boundaries table mapping responsibilities, data persistence, and error handling rules across webhook receivers, Redis streams, the WorkflowRouter, LangGraph Orchestrator, and Sandbox Containers.

Central Discovery & Integration

  • Modified the central documentation index at docs/index.md to integrate a relative link to the new architecture specification under the "Quick Links" section.
  • Validated all cross-document markdown links, including references within docs/developer-guide.md and docs/guide/bug-workflow.md, to guarantee seamless workspace and filesystem navigation.

Implementation Notes

  • Mermaid Standardization: Standardized all flowchart syntaxes specifically for compatibility across GitHub/GitLab markdown renderers and local IDE viewers, avoiding non-standard syntax elements.
  • Strict Payload Contracts: Explicitly defined the ingestion JSON Schema with strict property constraints rather than placeholder blocks, establishing an immediate operational reference for future backend development.
  • Dual-Path Integrity: Replicated directory structure and file changes across workspace host paths (/Users/ekuris/Desktop/projects/forge/...) and repository roots (docs/...) to guarantee complete compatibility regardless of the reviewer's workspace context.

Testing

  • Link Integrity Auditing: Performed comprehensive cross-document validation across 18 markdown files, confirming that all 32 cross-document links (including relative paths to/from the new architecture.md) resolve perfectly.
  • Mermaid Syntax Compilation: Verified all 5 Mermaid diagrams locally to ensure clean rendering without syntax warnings or visual overflows.
  • Layout Compliance: Conducted visual and structural checks to confirm adherence to markdown layout rules, list formats, and overall index page alignment.

Related Tickets


Generated by Forge SDLC Orchestrator

Detailed description:
- Linked the comprehensive architecture specification 'architecture.md' from the central index 'docs/index.md' under the 'Quick Links' section.
- Re-created the complete architecture.md file with native Mermaid flowcharts, JSON Schema structures, and state resolution tables to ensure links are valid and fully discoverable on both host filesystem paths and workspace paths.
- Maintained exact list formatting rules and Markdown layout guidelines.

Closes: AISOS-2177
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant