-
Notifications
You must be signed in to change notification settings - Fork 45
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
Comments
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. |
Is this issue still available if yes then can you assign me? |
@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. |
Thank for assigning, will sure ask if needed any help |
Hey @MihirKohli Can we work on it together? |
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. |
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?.
The text was updated successfully, but these errors were encountered: