CU-DBMI / set-website

Website for the software engineering team (SET)
https://cu-dbmi.github.io/set-website
BSD 3-Clause "New" or "Revised" License
1 stars 3 forks source link

ToTW: Linting Documentation as Code #11

Closed d33bs closed 1 year ago

d33bs commented 1 year ago

This PR adds content for a new "tip of the week" blog post covering a few tools which enable one to lint documentation similarly to code. I'd welcome any comments or suggestions you may have, thanks a bunch!

netlify[bot] commented 1 year ago

Deploy Preview for set-website ready!

Name Link
Latest commit ff066f380c3975e4a0d8bd685aec146660864a26
Latest deploy log https://app.netlify.com/sites/set-website/deploys/63b83be61f9c060009dd3fb9
Deploy Preview https://deploy-preview-11--set-website.netlify.app/2023/01/03/linting-documentation-as-code
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 settings.

vincerubinetti commented 1 year ago

Looks like the two-col code block problem is due to a min-width being set somewhere on one of the children elements, preventing the cols from shrinking as they should. I also noticed some other css bugs with it (padding), so let me fix it up before merging.

d33bs commented 1 year ago

Sounds good, thank you @vincerubinetti !

vincerubinetti commented 1 year ago

You can apply this commit and it should fix it: https://github.com/greenelab/lab-website-template/commit/ad4a6eb241b72bdffc649ccb94d0686dc491a233

d33bs commented 1 year ago

Thanks again @vincerubinetti !

d33bs commented 1 year ago

Thank you @falquaddoomi !