Skip to content

Replace ASCII architecture diagrams with rendered images - #257

Merged
HiranAdikari merged 1 commit into
wso2:mainfrom
sameera-87:main
Aug 13, 2026
Merged

Replace ASCII architecture diagrams with rendered images#257
HiranAdikari merged 1 commit into
wso2:mainfrom
sameera-87:main

Conversation

@sameera-87

@sameera-87 sameera-87 commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

… architecture.md file

Summary

Replace the ASCII-art architecture overview diagram in docs/architecture.md with a rendered PNG (docs/media/architecture-overview.png)
Replace the ASCII-art module dependency graph with a rendered PNG (docs/media/module-dependency-graph.png)
Both images retain descriptive alt text summarizing the diagram content for accessibility

Summary by CodeRabbit

  • Documentation
    • Replaced text-based architecture and module dependency diagrams with linked visual diagrams.
    • Improved documentation readability and visual clarity.

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 8149da48-c96f-4b23-a091-fbd349af56f7

📥 Commits

Reviewing files that changed from the base of the PR and between 25cb78e and 0a817e6.

⛔ Files ignored due to path filters (2)
  • docs/media/architecture-overview.png is excluded by !**/*.png
  • docs/media/module-dependency-graph.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • docs/architecture.md

📝 Walkthrough

Walkthrough

The architecture documentation replaces the inline architecture and module dependency diagrams with linked image assets.

Changes

Architecture documentation

Layer / File(s) Summary
Replace inline architecture diagrams
docs/architecture.md
The document links to media/architecture-overview.png and media/module-dependency-graph.png instead of using inline text diagrams.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the change but omits the required Changes, Testing, and Checklist sections. Add the Changes, Testing, and Checklist sections, and provide validation results and checklist status.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main documentation change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@HiranAdikari
HiranAdikari merged commit 73e4d4e into wso2:main Aug 13, 2026
2 of 4 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.

3 participants