Skip to content

docs: restructure architecture docs and add GitHub external auth config - #180

Merged
Nexus-AgentFlow merged 2 commits into
developfrom
docs/restructure-architecture-docs
Sep 3, 2026
Merged

docs: restructure architecture docs and add GitHub external auth config#180
Nexus-AgentFlow merged 2 commits into
developfrom
docs/restructure-architecture-docs

Conversation

@Christiantyemele

Copy link
Copy Markdown
Collaborator

Summary

Restructures the documentation set, replacing legacy/stale architecture documents with openflows-specific ones, and adds GitHub App external auth configuration.

Changes

  • Docs restructure: Removes outdated architecture documents (AGENT_BOOTSTRAP, ORCHESTRATOR, TESTING_GUIDE, a2a-verification, agent-orchestration-protocol, coder-compatibility, system-behavior, vessel-agent, etc.) and adds new openflows-specific docs:
    • docs/architecture/openflows-a2a-relay.md
    • docs/architecture/openflows-controller.md
    • docs/architecture/openflows-redis-shared-store.md
    • docs/architecture/openflows-system-architecture.md
    • docs/architecture/openflows-worker-workspace.md
    • Supporting asset images under assets/
  • Config: Adds GitHub App (external auth) setup guidance to .env.example and docker-compose.yml
  • Version: Bumps orchestration version to 1.2.1
  • Updates README, QUICK_START, TESTING_QUICK_START, RELEASING, and scripts docs to reflect the restructure

@Nexus-AgentFlow
Nexus-AgentFlow changed the base branch from chore/single-release to main September 3, 2026 09:54
@Nexus-AgentFlow
Nexus-AgentFlow changed the base branch from main to develop September 3, 2026 09:56
@greptile-apps

greptile-apps Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The PR replaces legacy architecture documentation with an OpenFlows-specific documentation set, adds GitHub App external-auth configuration, and advances the orchestration version.

  • Adds five subsystem and system-level architecture guides with supporting diagrams.
  • Updates setup, testing, release, and script documentation for the consolidated openflows CLI.
  • Adds Coder GitHub external-auth environment configuration to the example environment and Docker Compose stack.
  • Removes superseded architecture and operational documents.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
docs/architecture/openflows-system-architecture.md Adds the authoritative system-wide architecture and routes readers to subsystem deep dives.
docs/architecture/openflows-controller.md Adds the controller architecture, lifecycle, reconciliation, and orchestration design.
docs/architecture/openflows-redis-shared-store.md Documents shared-state keys, tenancy, durability, and coordination contracts.
docs/architecture/openflows-worker-workspace.md Documents worker provisioning, bootstrap, hooks, and workspace lifecycle.
docs/architecture/openflows-a2a-relay.md Documents delegated verification, relay behavior, and persistence invariants.
docker-compose.yml Adds configurable Coder GitHub App external-auth environment variables.
.env.example Adds setup guidance and example variables for GitHub App external authentication.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart LR
  README[README and quick-start guides] --> System[System architecture]
  System --> Controller[Controller]
  System --> Store[Redis SharedStore]
  System --> Workspace[Worker workspace]
  System --> Relay[A2A relay]
  Compose[Docker Compose] --> Coder[Coder]
  ExternalAuth[GitHub App external auth] --> Coder
Loading

Reviews (4): Last reviewed commit: "docs: repair dangling links after archit..." | Re-trigger Greptile

Comment thread docs/architecture/openflows-a2a-relay.md Outdated
Christiantyemele pushed a commit that referenced this pull request Sep 3, 2026
Replace references to deleted docs (AGENT_BOOTSTRAP, ORCHESTRATOR,
a2a-verification, vessel-agent, coder-compatibility, extending,
governance, tenancy, OpenFlows_Coder_Integrated_Architecture,
openflows-control-decisions) with the surviving openflows-* architecture
docs, per review feedback on PR #180.
AgentFlow added 2 commits September 3, 2026 12:12
Replace legacy/stale architecture documents with openflows-specific ones (a2a
relay, controller, redis shared store, system architecture, worker workspace)
and their assets. Update .env.example and docker-compose for GitHub App
external auth, bump orchestration version to 1.2.1.
Replace references to deleted docs (AGENT_BOOTSTRAP, ORCHESTRATOR,
a2a-verification, vessel-agent, coder-compatibility, extending,
governance, tenancy, OpenFlows_Coder_Integrated_Architecture,
openflows-control-decisions) with the surviving openflows-* architecture
docs, per review feedback on PR #180.
@Christiantyemele
Christiantyemele force-pushed the docs/restructure-architecture-docs branch from ba41eda to 07cf801 Compare September 3, 2026 11:14
@Nexus-AgentFlow
Nexus-AgentFlow merged commit f0daf39 into develop Sep 3, 2026
11 checks passed
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.

2 participants