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

Add descriptions of each filter to the main README.md #125

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

the-solipsist
Copy link
Contributor

This pull request helps address the problem of not knowing what's in each filter's folder in case the filter title isn't descriptive enough.

This pull request helps address the problem of not knowing what's in each filter's folder in case the filter title isn't descriptive enough.
@jgm
Copy link
Member

jgm commented Oct 19, 2020

This would require manual modification of the main README.md any time a filter is added.

We could adopt the convention that the first paragraph of a filter's README.md should be a short general description (this is true already in most if not all cases), and then create a Makefile target that updates the main README.md from these.

(Also, it would be good to keep line lengths to < 80 characters, as is the case throughout most of this repository.)

@jgm
Copy link
Member

jgm commented Oct 19, 2020

Of course, another option would be to document modifying the main README.md as part of the filter submission process.

@the-solipsist
Copy link
Contributor Author

I feel adding to the main README.md as part of the filter submission process would be the way to go. I feel having an overview of all the filters on a single page is very useful.

@alerque
Copy link
Collaborator

alerque commented Dec 12, 2020

I remember first finding and exploring this repository and wishing it had an overview index like this. The upkeep is a little bit of work, but I think making the filters more approachable is probably worth it.

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

Successfully merging this pull request may close these issues.

3 participants