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

Better Organization #35

Open
Blankscreen-exe opened this issue Sep 7, 2024 · 2 comments
Open

Better Organization #35

Blankscreen-exe opened this issue Sep 7, 2024 · 2 comments

Comments

@Blankscreen-exe
Copy link

This has already been mentioned but I am proposing something new here along the same lines.

We have fewer categories for projects so they are easily searchable ... but not quite. This README will eventually grow up to be a massive scroll feed in which a single item would take too long to find. We can divide the document into several smaller parts like this:

README.md // only lists the categories
|- categories
    |- commandLine
        |- index.md // contains a list of links of related projects present in "commandLine" directory 
        |- apple.md
        |- banana.md
        |- orange.md  
    |- games
        |- index.md // contains a list of links of related projects present in "games" directory 
        |- icecream.md
        |- youscream.md
        |- allscream.md  
    |- desktopApps
        |- index.md // contains a list of links of related projects present in "desktopApps" directory 
        |- laptop.md
        |- monitor.md
        |- keyboard.md

This will enable the contributors to add as much detail about a single idea as they want to make their ideas more understandable. Because now they have a single markdown file dedicated for their idea.

I am also open to ideas which can organize this repo in a better way.

@joereynolds
Copy link
Owner

I'd like to avoid dividing the document up if possible.

The beauty of it being all on one page is that you can scroll through it all in one go and pick and choose which ideas interest you.

With the proposed way above you'd have to click into each document to see what the idea is which adds friction to the "finding an idea" part.

I'm not against better categorising the headers and maybe wrapping up the descriptions in <details> boxes though:

Like this

That said, I do admit the categorisation needs some work but I don't think dividing it is the answer

@Blankscreen-exe
Copy link
Author

@joereynolds thanks for the input. I do feel like what you proposed is a much better alternative. But I'd like to know what do you feel about having all the projects with same category be on a single page, and the files would only be divided by category.

something like this:

categorioes/
|-  commandLine.md
|-  games.md
|-  desktopApps.md

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

2 participants