Skip to content

docs:improve README with tech stack and workflow sections#61

Open
Chandrika987 wants to merge 2 commits into
im-anishraj:mainfrom
Chandrika987:docs/improve-readme-structure
Open

docs:improve README with tech stack and workflow sections#61
Chandrika987 wants to merge 2 commits into
im-anishraj:mainfrom
Chandrika987:docs/improve-readme-structure

Conversation

@Chandrika987

@Chandrika987 Chandrika987 commented May 13, 2026

Copy link
Copy Markdown

Description

Improved the README documentation by adding dedicated Tech Stack, Workflow / How It Works, Basic Project Structure, and High-Level Workflow sections to make the project more beginner-friendly and improve contributor onboarding.

Fixes #15

Type of Change

  • 🐛 Bug fix
  • 🚀 New feature
  • 📝 Documentation update
  • 🧹 Refactoring

Checklist

  • I have read the contributing guidelines.
  • My code follows the style guidelines of this project.
  • I have added/updated tests if applicable.
  • All new and existing tests passed.

@Chandrika987

Copy link
Copy Markdown
Author

Hi @im-anishraj ,
I noticed GitHub is showing a merge conflict warning, likely because the README has been updated recently on the main branch as well.
My changes are scoped only to improving the documentation structure by adding Tech Stack, Workflow, Project Structure, and High-Level Workflow sections for better contributor onboarding.

Please let me know if you'd like me to sync with the latest main branch and resolve the conflict from my side. Thank you!

@im-anishraj

Copy link
Copy Markdown
Owner

Hi @Chandrika987, thanks for the update.

I checked the changes, and they look good to me. I especially liked the improved README structure and the Tech Stack / Workflow sections — they make the project much easier to understand for new contributors.

The merge conflict is fine from my side. Please go ahead and sync with the latest main branch and resolve it whenever convenient.

Appreciate the effort on this update.

@Chandrika987

Copy link
Copy Markdown
Author

Hi @im-anishraj ,
I’ve resolved the README merge conflicts by syncing with the latest main branch and cleaned up the documentation sections accordingly.
If everything looks good from your side, kindly consider merging the PR. Thank you!

@Chandrika987

Copy link
Copy Markdown
Author

Hi @im-anishraj
I hope you're doing well. I wanted to follow up on my PR and check if there are any updates or feedback when you have a chance. I'd be happy to make any required changes.

Thank you for your time.

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.

Enhance README with Tech Stack & Project Workflow Section

2 participants