Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve Project Documentation for Readability #15

Open
akshit-g opened this issue Jul 3, 2023 · 4 comments
Open

Improve Project Documentation for Readability #15

akshit-g opened this issue Jul 3, 2023 · 4 comments
Assignees
@avnigoyal25 @harshitgautam2003
Labels
documentation Improvements or additions to documentation Easy hacktoberfest Issues open for contribution under Hacktoberfest 2020

Comments

@akshit-g
Copy link
Contributor

akshit-g commented Jul 3, 2023 •
edited
Loading

The current project documentation lacks readability, making it difficult for developers, contributors, and users to understand the codebase, features, and usage. This affects collaboration, onboarding, and overall project efficiency.

Update Documentation Structure:
Reorganize the documentation into clear sections: Introduction, Installation, Usage, API Reference, Contribution Guidelines, etc.
Use clear headings and subheadings to break down content logically.

Improve Code Comments:
Review existing code comments and ensure they are clear and concise.
Comment on complex algorithms, functions, and classes to aid understanding.

Versioning Information:
Clearly indicate which version of the project the documentation corresponds to.
Provide links or instructions for accessing documentation for specific older versions if applicable.
@akshit-g akshit-g added documentation Improvements or additions to documentation OSoC’23 Easy labels Jul 3, 2023
@avnigoyal25
Copy link
Contributor

I can work on this issue.

@akshit-g
Copy link
Contributor Author

akshit-g commented Jul 9, 2023

I can work on this issue.

Assigned!

@akshit-g akshit-g changed the title Documentation Improve Project Documentation for Readability Sep 29, 2023
@akshit-g akshit-g added hacktoberfest Issues open for contribution under Hacktoberfest 2020 and removed OSoC’23 labels Sep 29, 2023
@harshitgautam2003
Copy link

Can I work on this issue?

@akshit-g
Copy link
Contributor Author

Can I work on this issue?

Sure!

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

@avnigoyal25 avnigoyal25

@harshitgautam2003 harshitgautam2003

Labels
documentation Improvements or additions to documentation Easy hacktoberfest Issues open for contribution under Hacktoberfest 2020
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@akshit-g @avnigoyal25 @harshitgautam2003