search

nhsengland / datascience

NHS England Data Science Team Website
https://nhsengland.github.io/datascience/
MIT License
8 stars 3 forks source link

README.md doesn't include detail required #112

Open harrietrs opened 5 months ago

harrietrs commented 5 months ago

IMO we should have a some high level detail on the README.md about how the website is built.

At the minimum this should include 'this website is built in mkdocs', and a link to the how to contribute md.

Currently we have a link to the website on top of a button which also links to the website. I understand this might be to redirect people who might be looking for the website when they stumble upon the github page, but at the moment this just looks messy.

SamHollings commented 5 months ago

Valid points! The same could be said of the RAP community of practice. It wouldn't take a great deal - a simple flow chart explaining how the build process works (mentioning Mkdocs and the Github action) and then describing the location of the github action file..

harrietrs commented 5 months ago

Thanks Sam, the way I see it: Minimum required to close issue- 'This website is built using mkdocs. Find out how to contribute (hyperlinked)' Extra- diagram, github actions explanation, etc.