inlab-geo / espresso

Earth Science PRoblems for the Evaluation of Strategies, Solvers and Optimizers
https://geo-espresso.readthedocs.io
Other
12 stars 9 forks source link

Rationalise docs & readmes #108

Closed valentineap closed 1 year ago

valentineap commented 1 year ago

We currently have a variety of README.md files scattered through the repository, and contributor/developer guides within the docs. This is a future maintenance headache, and I think we already have some inconsistent advice.

I propose that we consolidate all important information into the 'docs', within the contributor and developer guides, and delete it from the README files. Instead, these should contain links to the relevant docs pages.

@jwhhh If you agree, can you do the initial migration of information -- you are better-placed than me to determine which information is still current.

Builds on #107.

UPDATE: also include FAQ in this PR.