Repository navigation
Create and add a Mermaid workflow diagram to README #6
Description
To make our project more welcoming for beginners, we want to add a visual diagram explaining how the application workflow works. We need a contributor to create a Mermaid diagram and add it to our README.
Step to solve:
- Open the
README.mdfile and look at how the application operates (or check the main code logic). - Create a simple Mermaid diagram (like flowchart or sequence diagram) that illustrates the main workflow or architecture.
- Find the most fitting section for this diagram in the README, like architecture or How it works.
- Paste your Mermaid code block there and check the preview to make sure it renders nicely.
- Submit your Pull Request!
Note: Keep it simple and clear so that any newcomer can understand the basic flow of the project at a glance.
Activity
persianflower commentedon Aug 3, 2026
Hello, @IamGhost-ops I would like to work on this!
IamGhost-ops commentedon Aug 14, 2026
Hi!
Great to have you working on another task! Thank you so much for your continued support- it really means a lot to us.
Take your time and work at your own pace. If you need anything or run into any issues, just let me know here.
Good luck, and have fun with this one!
persianflower commentedon Aug 14, 2026
Heyy @IamGhost-ops, Since you only assigned this linked issue to me today I have yet to start working on it..so if you want you can simply merge the one done by @alienvisitor8675-bit instead