Skip to content

docs: improve README formatting and structure - #73

Merged
Labreo merged 3 commits into
Labreo:masterfrom
anishagrawal25:docs/improve-readme
Aug 9, 2026
Merged

docs: improve README formatting and structure#73
Labreo merged 3 commits into
Labreo:masterfrom
anishagrawal25:docs/improve-readme

Conversation

@anishagrawal25

Copy link
Copy Markdown
Contributor

Summary

Improves README formatting and structure to address #58.

Changes

  • Added a Table of Contents for easier navigation
  • Added a proper Installation section with setup commands
  • Added a Usage section with basic instructions
  • Fixed heading hierarchy and section organization
  • Improved Markdown formatting consistency
  • Fixed Contact & Support wording
  • Removed temporary README planning notes

Documentation-only change with no functional impact.

Fixes #58

Testing

N/A — documentation-only change. Verified all TOC anchor links resolve correctly and Markdown renders properly in GitHub preview.

Checklist

  • I have tested the change locally.
  • I have updated documentation if needed.

@github-actions

github-actions Bot commented Aug 8, 2026

Copy link
Copy Markdown

🎉 Thank you for your contribution! Your pull request has been received and will be reviewed shortly.

If you enjoy the project, please consider giving the repository a ⭐. You can also follow my GitHub profile to stay updated on future open-source projects.

Thanks for being part of the community! 🚀

@github-actions github-actions Bot added the merge ready PR is mergeable and has no conflicts label Aug 8, 2026
Comment thread README.md Outdated
**Have questions or want to discuss a major feature?** Reach out to me directly on **Discord**: `.kakaroth`

If this extension makes your daily workflow a little smoother, consider supporting the development!
If this extension makes your daily workflow a little smoother, consider ⭐ starring the repo!

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revert this or making it both.

@Labreo Labreo left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good changes overall.Well done.Just fix that one thing and I will let you merge.

@github-actions

github-actions Bot commented Aug 9, 2026

Copy link
Copy Markdown

@anishagrawal25, please resolve the commit so that it will be merged soon ......

@github-actions github-actions Bot added merge conflicts PR has merge conflicts and removed merge ready PR is mergeable and has no conflicts labels Aug 9, 2026
Updated the support message to encourage development support instead of starring the repo.
@anishagrawal25

Copy link
Copy Markdown
Contributor Author

Hi @Labreo,

I've reverted the support message as requested. Thanks for the review!

@Labreo
Labreo merged commit 938d555 into Labreo:master Aug 9, 2026
@Labreo

Labreo commented Aug 9, 2026

Copy link
Copy Markdown
Owner

lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve Readme Formatting and Structure

2 participants