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

Categorize examples by ecosystems #239

Open
gugakatsi opened this issue Oct 13, 2023 · 10 comments
Open

Categorize examples by ecosystems #239

gugakatsi opened this issue Oct 13, 2023 · 10 comments

Comments

@gugakatsi
Copy link

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

@Robson
Copy link
Collaborator

Robson commented Oct 13, 2023

What would be an example ecosystem?

@gugakatsi
Copy link
Author

gugakatsi commented Oct 13, 2023

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
Copy link
Contributor

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
Copy link
Collaborator

Robson commented Oct 13, 2023

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
Copy link
Author

@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
Copy link
Contributor

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
Copy link
Author

@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
Copy link

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
Copy link

fralfaro commented May 7, 2024

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.

@waldyrious
Copy link
Contributor

That's really cool, @fralfaro — nice work!

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