example-instancescan-checks icon indicating copy to clipboard operation
example-instancescan-checks copied to clipboard

Readme organization

Open chelming opened this issue 3 years ago • 6 comments

I think the repo is hitting a tipping point where it's hard to see, browse, and maintain the list of checks in the repos README.

Would enabling the wiki be better from a usability perspective so you can have hierarchy for the categories and automatically alphabetized lists? 🤷‍♀️

chelming avatar Oct 12 '22 18:10 chelming

It's 2 years old, but more relevant than ever :)

Lacah avatar Sep 29 '24 16:09 Lacah

An example way to do this would be standardising use of description and name to set that content. Then use Github actions or potentially an instance to either keep the readme up to date with collapsable sections or update the .wiki.git

SapphicFire avatar Oct 04 '24 12:10 SapphicFire

hi is this available for hacktoberfest2024, i would love to contribute

danieltayal07 avatar Oct 18 '24 08:10 danieltayal07

It sure is!

SapphicFire avatar Oct 18 '24 11:10 SapphicFire

hey @SapphicFire hope you are good,

i am sorry i won't be able to do it right now i have my mid semester exams going on till about 1-2 november.

is that much delay possible? if someone else comes in please give them in the meantime, i don't want to waste your time.

Thank you!

danieltayal07 avatar Oct 22 '24 11:10 danieltayal07

The repositories are always open for contributions, however it needs to be submitted during October to count toward Hacktoberfest.

wiz0floyd avatar Oct 23 '24 01:10 wiz0floyd