rcpch / digital-growth-charts-documentation

Documentation site for all parts of the RCPCH Digital Growth Charts Project
https://growth.rcpch.ac.uk/
5 stars 8 forks source link

Tidy up doc #30

Closed a-wei-william closed 3 years ago

a-wei-william commented 3 years ago

Tidy up pages under "Products"

a-wei-william commented 3 years ago

tidy up the reactive native client page

a-wei-william commented 3 years ago

tidy up command-line-client 529fa08

pacharanero commented 3 years ago

Hi @a-wei-0513 thanks for the PR! Let's get you set up with a test deployment that we can look at:

If you go into your GitHub Actions settings you should be able to enable the publish action, this is included in your fork of our repo, but GitHub disables Actions in forks for security reasons, you have to enable them manually. The Action has 2 parts: the second one (publish to Azure) will fail, but it won't matter because the first part is all you need for this.

Then go into GitHub Pages settings and enable the publication of the gh-pages branch of your fork, this will give us a nice page we can test your PR our before we merge, it would be at something like: https://a-wei-0513.github.io/digital-growth-charts-documentation/

a-wei-william commented 3 years ago

Hi @pacharanero I've done it

pacharanero commented 3 years ago

Looks good to me @a-wei-0513 - I would like @eatyourpeas to have a look as he wrote the CLI and the documentation for it Simon you can see the PR edits deployed at https://a-wei-0513.github.io/digital-growth-charts-documentation/products/command-line-client/

a-wei-william commented 3 years ago

fixes #31

pacharanero commented 3 years ago

@a-wei-0513 I have been having a look through this PR. There's a lot here so it may take a few more days to be ready to merge it.

I may actually merge it into a different branch on the rcpch organisation account so that we can make any final tweaks.

Small point of feedback about PRs is that when there is a lot of changes, can be better to do each 'functionally separate' atomic change in its own branch and make separate PRs for each.

Going forward we are trying to use a workflow that is

Single Issue => Feature branch to fix that issue => PR for that issue => Merge => Close issue

pacharanero commented 3 years ago

I've had a read through all of it now, and it's great stuff. Thanks so much for this.

The only modification I would like to request would be in the Products>CLI tools bit, could we use Markdown headings even for the Arguments/Options/Example bits? You've switched out H3s for bold text but I think for almost everything we are trying to stick to using headings as they are linkable. Could we switch these back and push the changes here and I'll merge.

a-wei-william commented 3 years ago

fixed #26 ?

pacharanero commented 3 years ago

@a-wei-0513 merged and I've added you to the Contributor list https://growth.rcpch.ac.uk/about/acknowledgements/

pacharanero commented 3 years ago

When we get you working on the Python code we can add that as well as documentation work!

a-wei-william commented 3 years ago

@pacharanero Great! Thank you 😁