Skip to content

docs: system overview #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 9, 2025
Merged

Conversation

edwardtay
Copy link
Collaborator

No description provided.

@edwardtay edwardtay changed the title docs: replace mermaid with image, fix research paper link formatting docs: system overview Apr 7, 2025
@selcukemiravci
Copy link
Collaborator

Thanks for the PR @edwardtay, great work overall!

A couple of suggestions to improve clarity and user experience:

Add a light mode version of the diagram

  • Right now, the black diagram works well for dark mode, but it's not fitting for the light mode. Could you include a white/light version of the image and dynamically switch between them based on the user's theme?

Include an introductory paragraph before diving into component details
It would help to start the page with a short paragraph that provides a high-level explanation of the system; what it does, its core purpose, and how the components work together. That way, readers get context before jumping into the architecture diagram and component breakdown.

@selcukemiravci
Copy link
Collaborator

Will complete the fixes on my end.

@selcukemiravci selcukemiravci merged commit 6809079 into main Apr 9, 2025
1 check passed
@selcukemiravci selcukemiravci deleted the docs/update-system-architecture branch April 9, 2025 02:16
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