[v2][Enhancement] Improve project and code documentation using LLMs

[Udayraj123]

Is your feature request related to a problem? Please describe. LLMs like ChatGPT can help make our project documentation easier to understand and fill any missing gaps.

• Currently the project documentation is present in the project wiki.
• Also the code comments are scarce except for the variable naming and the descriptions present json schemas that give some context.

Describe the solution you'd like We should leverage code understanding capabilities of the LLMs to greatly improve documentation. We can -

• Improve the existing User Guides in the Project wiki
• Incrementally add explanatory code comments which can be read by docs generators later
  • Looking for a good prompt that does this job well

Describe alternatives you've considered Developers have to refer to the provided samples to learn how to use each of the flags present in our template/evaluation schemas

Additional context We are also planning to move it into a dedicated docs/pages folder in future. Also exploring using docs generators like Docusaurus for more elaborate project and code documentation.

Note: please share your queries and approaches on discord for quicker discussions:

• Link to the Discord invite
• Link to the Hacktoberfest 2024 channel

[chirag4862]

I would love to work on this enhancement.

[Udayraj123]

Hey @chirag4862, good to hear that! Docs are crucial for a good adoption of the OMRChecker and I hope you'll be able to help them improve. Please go through the current wiki and share which part of it you'd like to work on.

[offline-keshav]

@Udayraj123 we can improve documentation by following steps

1. We need to improve explained comments in every program and module.
2. After that we need to improve 2 instructions manuals , one for normal user and other for devs.
3. The dev manual need to have working of project , which program does what. by this solving other issues will be very easy since file can be found/ accessed more easily and direct references to the files can be given.
4. LLMs like GPT can help with all these. I have done this thing in my earlier project too which can be accessed here and it did it very efficiently though there were some changes that need to be made.

Also I would like to work on this issue since.

[Udayraj123]

This is awesome. I'm assigning the task to you. Let me know if you need any clarification. Let's do it file by file I suppose. One more pointer is the schema/code differences in dev vs master branch. I think you can proceed by documenting the dev branch code since I will be releasing the v2 soon.

[Udayraj123]

Unassigning due to unavailability, discussed in discord