Skip to content

docs(architecture): make diagrams answer reader questions - #940

Closed
Juliusolsson05 wants to merge 2 commits into
mainfrom
docs/architecture-diagram-clarity
Closed

Juliusolsson05 wants to merge 2 commits into
mainfrom
docs/architecture-diagram-clarity

Conversation

@Juliusolsson05

Copy link
Copy Markdown
Owner

Several architecture diagrams repeated nearby inventories or compressed too many relationships into small labels. This revision keeps the opening application map and gives each detailed view a specific reader question, scope and takeaway.

  • Reduce 42 diagrams to 26, preserving the technical tables and every implementation link. Record all retain/remove decisions in the plan.
  • Use concrete examples for session identities, orchestration, missed workflow updates and live/saved message ownership. Focus sequences on ordering, failure and retry consequences.
  • Apply consistent blue/gray/amber roles, dashed external boundaries, readable labels and standalone titles/keys. Keep editable Mermaid sources and committed SVG previews.
  • Document the design principles and primary references in Appendix B; require question/scope metadata and reject obsolete previews in the renderer.

Read the revised architecture reference · Open the application map

Validation: 26/26 diagrams parse, render and reproduce byte for byte with --check; all decode as standalone SVG images. Reviewed at 960px and in grayscale, with no text outside the exported figures. Tested palette pairs exceed 4.5:1 for text and 3:1 for meaningful lines. Captions/accessibility metadata agree, all implementation links are preserved, and the Markdown check found no broken local paths or anchors across 117 headings and 373 links. Script syntax and whitespace checks pass.

Application runtime tests were not run because this changes documentation and its renderer only. The documented source snapshot remains 6a19e4ee. This follow-up is left as a draft for visual/content review.

Fixes #937
Refs #100

Audit all 42 views, retain 26 focused explanations, and use consistent visual roles with accessible standalone previews. Preserve implementation links and document the research and visual validation.

Refs #937, #100
@Juliusolsson05

Copy link
Copy Markdown
Owner Author

Combined into #954, which now targets main and includes this PR's two commits unchanged (plan ed378713 and 60453949), plus the observation/reconciliation chapter built on top of them. Review and merge #954 instead; it fixes #937.

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.

docs(architecture): make diagrams explain useful relationships

1 participant