Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md doesn't include detail required #112

Open
harrietrs opened this issue May 14, 2024 · 2 comments
Open

README.md doesn't include detail required #112

harrietrs opened this issue May 14, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@harrietrs
Copy link
Contributor

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.

@harrietrs harrietrs added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 14, 2024
@SamHollings
Copy link
Collaborator

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
Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants