docs: Split readme into various docs

openactive-archive / conformance-services

Harvests and normalises OpenActive Opportunity feeds to a common representation

MIT License

0 stars 0 forks source link

docs: Split readme into various docs #60

Closed odscjames closed 4 years ago

odscjames commented 4 years ago

This just moves all content from readme to docs folder. Adds one placeholder for final stage. No editing was done to content apart from some page titles.

michaelwood commented 4 years ago

I think there decent distinction between a README and docs.

Docs should be much more in-depth than a README.
It is useful to have a very highlevel README for running/install for people who know what they're doing

I'd be in favour of keeping most of the content in the README as is.

odscjames commented 4 years ago

Docs should be much more in-depth than a README.

I think they will be when we add more.

It is useful to have a very highlevel README for running/install for people who know what they're doing

I would suggest that's a separate requirement we should work on when we do more work on use cases for docs during the next sprint - we said this sprint and this morning we would just try and get content in now.