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

README is really long #105

Closed
zkoppert opened this issue Aug 25, 2023 · 7 comments · Fixed by #126
Closed

README is really long #105

zkoppert opened this issue Aug 25, 2023 · 7 comments · Fixed by #126
Labels
good first issue Good for newcomers

Comments

@zkoppert
Copy link
Member

The readme could be improved by having collapsable sections or making the examples collapsible. Maybe splitting some of the sections out into separate files that are links from the README would be good too?.

@zkoppert zkoppert added the good first issue Good for newcomers label Aug 25, 2023
@Okabe-Junya
Copy link
Contributor

This proposal seems excellent!!

Structuring the README is a great idea. Since this repository is included within a GitHub Organization, if there's a preferred approach within the organization, we might be able to follow it.

From what I've researched, the method used in the CodeQL repo appears to be commendable.

@MihirKohli
Copy link
Contributor

Is this issue still available if yes then can you assign me?

@zkoppert
Copy link
Member Author

@MihirKohli I've added you as the assignee. Thanks for volunteering to take this one on. Let me know if there is any support I can offer you.

@MihirKohli
Copy link
Contributor

MihirKohli commented Sep 20, 2023

Thank for assigning, will sure ask if needed any help

@rajveer43
Copy link
Contributor

Thank for assigning, will sure ask if needed any help

Hey @MihirKohli Can we work on it together?

@rajveer43 rajveer43 mentioned this issue Sep 21, 2023
4 tasks
@MihirKohli
Copy link
Contributor

MihirKohli commented Sep 21, 2023

@MihirKohli I've added you as the assignee. Thanks for volunteering to take this one on. Let me know if there is any support I can offer you.

Should I structure README similarly to the CodeQL Repo by separating it into sections? I have made it concise, so it should have better readability.

@MihirKohli
Copy link
Contributor

@zkoppert #131

@MihirKohli MihirKohli removed their assignment Sep 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants