Tidy Readme for Documentation signposting

NOC-MSM / pyBDY

pyBDY: a Python based regional NEMO model configuration toolbox.

GNU General Public License v3.0

7 stars 7 forks source link

Open jpolton opened 1 year ago

jpolton commented 1 year ago

At the top of the repo Readme file

Signpost the readthedocs documentation as the place to go (not as a working in progress)
Clarify the role of the wiki docs
Clarify, or remove, the role of the following content in the Readme

jpolton commented 1 year ago

Plan: keep only readthedocs

jpolton commented 1 year ago

Proposed plan for deleting wiki

Add hints_and_tips.rst to docs/source folder.
Copy in only wiki pages: Accessing Data page and SSHFS (if it is still relevant? - I've not used SSHFS in a few years)
Delete wiki (which can be deleted under 'Settings/Features')

@jdha if you are happy with this suggestion, I can do it. But I wouldn't want to remove stuff that you think is valuable.