Skip to content

docs: expand Architecture section with actors and data flow diagram - #68

Merged
paradoxbound merged 1 commit into
mainfrom
docs/architecture-actors
Mar 8, 2026
Merged

paradoxbound merged 1 commit into
mainfrom
docs/architecture-actors

Conversation

@paradoxbound

Copy link
Copy Markdown
Owner

Summary

  • Adds an Actors table listing all system participants (MCP client, server, BookStack API client, BookStack instance, operator)
  • Adds an ASCII data flow diagram showing how requests travel through the system end-to-end
  • Documents key design decisions (native fetch, stdio transport, Zod validation, write-gate, monorepo split)

Satisfies OSPS-SA-01.01 — project documentation must include design documentation demonstrating all actions and actors within the system.

Test plan

  • README renders correctly on GitHub
  • ASCII diagram is readable in plain text

🤖 Generated with Claude Code

@paradoxbound
paradoxbound force-pushed the docs/architecture-actors branch 2 times, most recently from 0e1fde7 to 3fbb5fa Compare March 8, 2026 14:44
Signed-off-by: Paradoxbound <paradoxbound@users.noreply.github.com>
@paradoxbound
paradoxbound force-pushed the docs/architecture-actors branch from 8c9ba96 to 3d5ec3b Compare March 8, 2026 14:48
@paradoxbound
paradoxbound merged commit bc5dbee into main Mar 8, 2026
13 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.

1 participant