DOC: Add Detailed Comments to All Pages in the New CodeBase

[shreyash3087]

What's wrong with the existing documentation

Description:

Currently, the codebase for our website lacks sufficient comments, making it difficult for developers to understand the code and maintain it effectively. To improve code readability, ease of maintenance, and onboarding of new developers, we need to add clear, concise, and informative comments throughout the codebase. This will also help in debugging and updating the code in the future.

Tasks:

• Identify Key Areas
• Add comments to explain the purpose of complex functions and classes.
• Describe the functionality of important code blocks.
• Clarify the logic behind key algorithms and data manipulations.
• Update or create documentation to reflect changes and provide guidelines on how to comment code effectively in the future.

Add ScreenShots

N/A

Record

• [X] I agree to follow this project's Code of Conduct
• [X] I'm a GSSOC'24 contributor
• [X] I'm a VSoC'24 contributor
• [X] I want to work on this issue

[github-actions[bot]]

Thank you for creating this issue! 🎉 We'll look into it as soon as possible. In the meantime, please make sure to provide all the necessary details and context. If you have any questions or additional information, feel free to add them here. Your contributions are highly appreciated! 😊

You can also check our CONTRIBUTING.md for guidelines on contributing to this project.

[mdazfar2]

@shreyash3087 Thanks for the suggestion! Task assigned to you for adding detailed comments.

[github-actions[bot]]

Hello @shreyash3087! Your issue #603 has been closed. Thank you for your contribution!