website icon indicating copy to clipboard operation
website copied to clipboard

Create Docs contribution guidelines

Open llewellyn-sl opened this issue 1 year ago • 7 comments

Adds a brief documentation style guide to encourage consistent tone and formatting in docs contributions.

@netlify /docs/contributing/documentation/docs_guidelines

llewellyn-sl avatar May 21 '24 18:05 llewellyn-sl

Deploy Preview for nf-core ready!

Name Link
Latest commit fb5ae884ca2ec5f29a59e2105bbf28bd3ac4c652
Latest deploy log https://app.netlify.com/sites/nf-core/deploys/664ce3ed14c74a000808578c
Deploy Preview https://deploy-preview-2535--nf-core.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar May 21 '24 18:05 netlify[bot]

Deploy Preview for nf-core-main-site ready!

Name Link
Latest commit 68546bffe0235b674356ba9a83b1cef1819d8d08
Latest deploy log https://app.netlify.com/sites/nf-core-main-site/deploys/66e063656111c800081e8a9c
Deploy Preview https://deploy-preview-2535--nf-core-main-site.netlify.app/docs/contributing/documentation/docs_guidelines
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar May 21 '24 18:05 netlify[bot]

@nf-core-bot fix linting

mashehu avatar May 22 '24 07:05 mashehu

@nf-core-bot fix linting

mashehu avatar May 23 '24 16:05 mashehu

Love this as well!

christopher-hakkaart avatar May 30 '24 09:05 christopher-hakkaart

@llewellyn-sl I went to edit the title of the page as it was a bit long, and got a bit carried away making formatting tweaks 😆 (the irony is not lost on me).

You can see the changes in 1b8b0c5aa26039e56caee18a899f38dce550a069, see also the deployment preview above for how it renders (should update in a few minutes). Can you check that you're happy with these please?

ewels avatar May 31 '24 08:05 ewels

added now the code block example and updated it to the new site strucutre (I put it into the guidelines section). There were some left-over items from the fastquorum blogpost which I also cleaned-up during the merge.

Hit the merge button whenever you think is fine, @llewellyn-sl

mashehu avatar Jul 31 '24 07:07 mashehu

Apologies for the long delay here, folks. This one fell off my radar. I made a minor change to the code blocks instruction — @ewels @mashehu this is ready to merge.

llewellyn-sl avatar Sep 10 '24 15:09 llewellyn-sl