matiassingers / awesome-readme

A curated list of awesome READMEs
17.83k stars 3.81k forks source link

Categorize examples by ecosystems #239

Open gugakatsi opened 11 months ago

gugakatsi commented 11 months ago

I think It'd be great, maybe small web-page for it with filters etc...

Robson commented 11 months ago

What would be an example ecosystem?

gugakatsi commented 11 months ago

Javascript, Web, Mobile... - all have specific problems and common languages. Today I wanted to see READMEs of js libraries, how they communicate with users quickly, and where/when they mention certain stuff. Can you get a sense of what I mean?

EDIT: It could be solved by including tags in README ( like for some projects could be: [ javascript, web, node, cjs ], ) so the user can find them easily with ctrl + f ( I tried that today). But I think a small filtering web-page would make researching better in many ways.

waldyrious commented 11 months ago

I prefer the idea of tags to a single categorical division, since different people may have different needs in how they would group the listed entries.

Robson commented 11 months ago

The list of readme files has grown quite large, so a way to categorise them would be helpful. I agree that tagging is the best approach, for the same reason as @waldyrious

gugakatsi commented 11 months ago

@Robson @waldyrious What do you think is a good solution for categorizing ? The first thing I thought was just parsing all readmes from the list, grabbing keywords from them, then sorting them automatically, and after that, we could manually edit it a bit or just make sorting automation better/good.

waldyrious commented 11 months ago

grabbing keywords from them

What's your idea of how to do this? Some sort of automated analysis of salient tokens, or matching the text of the READMEs to a predefined list of terms, or just reading the text and manually collecting relevant keywords?

It seems to me that it may be easier to just define a set of tags based on a high-level overview of the existing READMEs, add them to the listed READMEs as appropriate, and allow people to manually add more tags if the need arises.

gugakatsi commented 11 months ago

@waldyrious I think matching with a predefined list of terms ( source haven't thought yet, but handlable ) and a little bit of salient token analysis, Doing it once ( and so ) could give us good results in many ways. What do you think

fralfaro commented 5 months ago

Hello everyone, I made a small page for this repository:

It would be good to have something like the Awesome GitHub Profile READMEs page where some filters have already been defined, to sort the readmes:

fralfaro commented 4 months ago

Hello everyone!

I'm excited to announce an update to documentation. I've revamped the process, making it more streamlined and dynamic. Now, instead of manual updates, the information is extracted directly from "README.md" file and transformed into documentation automatically using Jinja2 with Python.

But that's not all! I've also added images for each link, enhancing the visual experience and aligning with the aesthetics of the "AWESOME" concept.

Check out the revamped documentation at the link below, and feel free to share your thoughts and feedback.