codeforpdx / recordexpungPDX

A project to automate the expungement of qualifying criminal records in Oregon. This project is done in conjunction with Qiu-Qiu Law.
https://recordsponge.com
MIT License
49 stars 87 forks source link

Consolidate documentation across the project #638

Closed KentShikama closed 4 years ago

KentShikama commented 4 years ago

Currently, we have 3 different locations that seem to give various details about the project:

We should stick to one location or else it becomes confusing: I've been on the project for 2 months now but I only discovered last week about the expungement flow chart https://www.draw.io/#G1aLwddaCPTUMazWIat-U6nMyWf0Qdgvfe from @wittejm . I would suggest https://github.com/codeforpdx/recordexpungPDX/tree/master/doc but I have no strong preferences.

hmarcks commented 4 years ago

Agreed. I vote for the wiki but am fine with any.

wittejm commented 4 years ago

I think the readme.md and doc/ is the place to keep everything that's important to for getting started as a contributor.

Since there's unavoidably "useful" documentation that isn't essential reading for devs we should still have the wiki IMO. A sentence in the readme encouraging people to see the wiki for the useful-but-less-organized documentation is worthwhile.

Deleting the io page sounds great.

wittejm commented 4 years ago

I deleted the io page, so I'm closing this issue.