docs: improve architecture diagrams readability#21
Merged
Conversation
Replace the README Mermaid diagram with a rendered context diagram and add dedicated PlantUML context/sequence diagrams under docs/diagrams with docs/architecture.md as an index. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR improves architecture documentation readability by replacing the inline Mermaid diagram in README.md with rendered images and adding a dedicated architecture page with PlantUML-backed context/sequence diagrams.
Changes:
- Replace the README Mermaid flowchart with a rendered context diagram image and add links to diagram sources.
- Add
docs/architecture.mdto centralize context + sequence diagrams. - Add PlantUML diagram sources (and rendered PNGs) under
docs/diagrams/for easier maintenance.
Reviewed changes
Copilot reviewed 5 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Swaps Mermaid for a rendered context diagram and links to the detailed architecture doc. |
| docs/architecture.md | New doc page that embeds the context + sequence diagram renders and references their sources. |
| docs/diagrams/context-autocomplete-system.puml | New PlantUML context diagram describing system components and interactions. |
| docs/diagrams/sequence-search-ingestion.puml | New PlantUML sequence diagram for ingestion → CDC → Redis indexing. |
| docs/diagrams/sequence-autocomplete-query.puml | New PlantUML sequence diagram for autocomplete query flow. |
| docs/diagrams/context-autocomplete-system.png | Rendered image output for the context diagram (binary). |
| docs/diagrams/sequence-search-ingestion.png | Rendered image output for the ingestion/indexing sequence diagram (binary). |
| docs/diagrams/sequence-autocomplete-query.png | Rendered image output for the autocomplete query sequence diagram (binary). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Address Copilot review feedback by explicitly showing SearchStatsTopology output to the search-stats Kafka topic in the context diagram. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Notes