docs: enhance JSDoc documentation in utils/index.js (#210)

[DevAbdelrahmanSayed]

Description

Enhanced JSDoc documentation in src/lib/utils/index.js to improve developer experience and code maintainability.

Changes Made

• ✅ Added detailed return type documentation for getRepoParts function
• ✅ Added usage example for capitalizeText function
• ✅ Improved parameter descriptions for all utility functions
• ✅ Ensured consistency across all JSDoc comments

Related Issue

Fixes #210

Testing

• All tests pass (npm run test)
• Build completes without errors (npm run build)
• No code logic changes - documentation only
• JSDoc follows best practices with detailed descriptions

Definition of Done

• All functions have complete JSDoc parameter descriptions
• Return types are clearly documented
• Example added for capitalizeText function
• Documentation is consistent across the file

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
jargons-dev	Ready	Preview	Comment	Oct 19, 2025 11:02pm

💡 Enable Vercel Agent with $100 free credit for automated AI reviews

[babblebey]

Look good @DevAbdelrahmanSayed, though it's a little more changes than expected of you to do... It's manageable, so I'll take this for now!

Quick note for next time

• Please make the exact changes you are expected to make, nothing more

Thank you for making your first contribution to the project 🎊

[babblebey]

I'd like your feedback, @DevAbdelrahmanSayed

• Did you run the project locally??
• How was your experience following the docs as you did?
• Is this your first ever contribution to Open source?

[DevAbdelrahmanSayed]

@babblebey
Yes, I ran the project locally and checked the code structure.
The docs are really good they made it easy to follow the contribution guide and set everything up.

This is actually my first open source contribution, and I’m happy about it,
I started with a small issue to get used to the process, but I have experience and would love to take on more issues next.

[DevAbdelrahmanSayed]

@babblebey
If there are any other issues or projects where I can contribute, please let me know I’d be happy to jump in!

[babblebey]

Hey @DevAbdelrahmanSayed

Thanks for the feedback... Appreciate it!

Please explore the issues section, theres other issues you can pick up... Provided the issue doesn't have the closed label (see https://github.com/jargonsdev/jargons.dev/blob/main/CONTRIBUTING.md#labels-closed-to-community-pickup) and it's not assigned to anybody already... You can go on and ask to work on it 😁