Add basic support for in-app "Quick Start" guides #4928
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Markdown spellcheck and link check | |
| on: | |
| pull_request: | |
| push: | |
| branches: | |
| - "main" | |
| permissions: | |
| contents: read | |
| jobs: | |
| # BEWARE(streetsidesoftware/cspell-action#187): a misconfigured cspell will _not_ have a non-zero exit code... | |
| spellcheck: | |
| name: Spellcheck | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: streetsidesoftware/cspell-action@v3 | |
| with: | |
| config: "docs/cspell.json" | |
| files: "**/*.md" | |
| strict: true | |
| incremental_files_only: false | |
| linkinator: | |
| name: linkinator | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: jprochazk/linkinator-action@main | |
| with: | |
| paths: "**/*.md" | |
| linksToSkip: "https://crates.io/crates/.*, https://github.com/rerun-io/rerun/pull/.*" # Avoid crates.io rate-limiting, and skip changelog PR links (so many) | |
| retry: true | |
| retryErrors: true | |
| retryErrorsCount: 5 | |
| retryErrorsJitter: 2000 | |