docs: Redrafts readme to capture vision - Githubissues

qri-io / walk

Webcrawler/sitemapper

GNU General Public License v3.0

6 stars 2 forks source link

docs: Redrafts readme to capture vision #29

Closed Frijol closed 4 years ago

Frijol commented 5 years ago

My friends! I watched/read the latest Archiving meeting and think I have a better idea of what we're trying to do. I've taken my understanding and drafted it into readme form.

Please review!

The primary purpose of this is to check that we're all on the same page. It's pretty likely I got something wrong, so please read carefully and poke holes! That's what a straw-type draft is for.

Secondary purpose (of course) is to document what we're doing for better communication internally & externally– suggestions welcome here as well.

Other questions:

In this PR, I deleted basically all of the old readme content because it looked like somebody's personal notes out of context. Are these still useful/is there a place I should put them?
There's some overlap and some informational conflict with roadmap.md. I wasn't sure what to do with that document. What is useful from it? What is out of date? Can I get rid of it and put the useful parts in the readme?

Overall, this PR and the original roadmap.md feel more like RFC process than straight content revision, but I think we can work with that in PR form..

b5 commented 5 years ago

Eep, while I'm not sure we have consensus on this change, you shouldn't have to screen-grab. Here's a proper diagram:

Artboard 1