search

codeforamerica / civic-tech-patterns

common patterns and anti-patterns for civic tech and civic apps
http://codeforamerica.github.io/civic-tech-patterns
BSD 3-Clause "New" or "Revised" License
192 stars 25 forks source link

Meta: Outgrowing a single Readme? #29

Open bensheldon opened 10 years ago

bensheldon commented 10 years ago

I've now heard from 2 people (trending?) that the current single-file readme format is getting difficult to read. In my mind, the way to grow is towards a middleman/jekyll format in which each pattern lives in its own markdown file and this would live at its own web-address (I'd make travis do the compilation/publishing automatically tho)

Benefits: easier to format for consumption Drawbacks: more daunting for contributors, more difficult to find (arguable?), complexity

migurski commented 10 years ago

Potentially confounding factor: growth in README complexity reflects an unsustainable increase in underlying code complexity, and instead of growing the README we should be shrinking the code by parceling off libraries and components to new repositories with their own README. IOW it's a smell not a bug.

junosuarez commented 9 years ago

My biggest issue is I want a URL for each pattern. Currently the readme (as rendered by github) offers that with hash fragments. If it's broken out, it should have good, stable URLs

junosuarez commented 9 years ago

See also https://github.com/codeforamerica/civic-tech-patterns/issues/40

pudo commented 9 years ago

Talking about this: I'll be at the summit in SF next week, is anyone else up for doing a quick sprint to merge pattern repos? It'd be great to have them all in one place and to collect some examples!

bensheldon commented 9 years ago

That would be great. I'll be at the Summit Day 1, but we could schedule a meeting whenever during the following days (I just can't be there for all the sessions).

On Wed, Sep 17, 2014 at 12:26 PM, Friedrich Lindenberg notifications@github.com wrote:

Talking about this: I'll be at the summit in SF next week, is anyone else up for doing a quick sprint to merge pattern repos? It'd be great to have them all in one place and to collect some examples!

Reply to this email directly or view it on GitHub: https://github.com/codeforamerica/civic-tech-patterns/issues/29#issuecomment-55946546

junosuarez commented 9 years ago

@pudo: timing will be tight, but I'm definitely interested in the idea!