name: Docs CI

### Run on *EVERY* commit. The documentation *SHOULD* stay valid, and
### the developers should receive early warning if they break it.
on: [push, pull_request]

jobs:
  check-markdown:
    runs-on: ubuntu-18.04
    timeout-minutes: 5
    steps:
    - uses: actions/checkout@v2
    - name: Build V
      run: make
    - name: Check markdown line length & code examples
      run: ./v check-md -hide-warnings .
    ## NB: -hide-warnings is used here, so that the output is less noisy,
    ## thus real errors are easier to spot.