docs icon indicating copy to clipboard operation
docs copied to clipboard

vale poc

Open dvdksn opened this issue 3 years ago • 3 comments

This is a demo, showcasing how vale could be used and set up to help enforce style guide rules on content.

dvdksn avatar Aug 12 '22 11:08 dvdksn

Deploy Preview for docsdocker ready!

Built without sensitive environment variables

Name Link
Latest commit 587a9ef3e84780b6288005c7fa152c3000617220
Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/62f63b9bca138e0008445368
Deploy Preview https://deploy-preview-15371--docsdocker.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 settings.

netlify[bot] avatar Aug 12 '22 11:08 netlify[bot]

Deploy Preview for docsdocker ready!

Built without sensitive environment variables

Name Link
Latest commit fce7437d3cabbed25e2c7138d6e2a1372e69154d
Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/6318ac8bb147770008def894
Deploy Preview https://deploy-preview-15371--docsdocker.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 settings.

netlify[bot] avatar Aug 12 '22 11:08 netlify[bot]

@usha-mandya this PR contains a tiny example of a vale config that can parse the docker docs for style/spelling errors.

Example:

➜  docker.github.io git:(vale) vale desktop/extensions.md 

 desktop/extensions.md
 15:3   error       Did you really mean             Vale.Spelling        
                    'extenstions'?                                       
 65:4   suggestion  Try to keep headings short (<   Docker.HeadingLength 
                    8 words).                                            
 83:83  error       Did you really mean 'Github'?   Vale.Spelling        

✖ 2 errors, 0 warnings and 1 suggestion in 1 file.

You could run vale as a CLI tool (above, useful in e.g. gh actions) or integrate it with your editor.

dvdksn avatar Aug 12 '22 11:08 dvdksn