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.

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

[DOC] Breaking the README into multiple files #1018

Open
Vignesh025 opened this issue Oct 2, 2024 · 5 comments
Open

[DOC] Breaking the README into multiple files #1018

Vignesh025 opened this issue Oct 2, 2024 · 5 comments
Assignees

Comments

@Vignesh025
Copy link

Vignesh025 commented Oct 2, 2024

The README is quite lengthy, and it might be better to split it into multiple files for better readability and organization. We can break down the different sections (e.g., installation, contributing, release notes and changelogs) into their own files, and link them back to the main README for easy reference.

If you think this is a good idea , Assign me to this issue and I'll start working on it.

@PRIYANKjakharia
Copy link

I don't mind working on it or assisting you as well.

@AMANCHAUBEY2277
Copy link

i will working with you

@Vignesh025
Copy link
Author

@PRIYANKjakharia and @AMANCHAUBEY2277, thank you for your interest, but I am currently working on this issue myself if it's assigned to me. Appreciate your understanding!

@NYDocutest NYDocutest assigned NYDocutest and Vignesh025 and unassigned NYDocutest Oct 6, 2024
@NYDocutest
Copy link
Contributor

Hi I assigned @Vignesh025 to this issue - but to @PRIYANKjakharia and @AMANCHAUBEY2277 I do think that there is significant room for improvement in the Read Me - even some graphics to make it more visually interesting, etc. as well so please post here other ideas you may have regarding the Read Me. THANK YOU!!!

@Vignesh025
Copy link
Author

@NYDocutest , Thankyou for assigning this issue to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants