docs: add docs on modules #835
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: Check Markdown links | |
| on: | |
| pull_request: | |
| paths: | |
| - "*.md" | |
| - "docs/docs/**.md" | |
| - "tests/e2e/README.md" | |
| jobs: | |
| repo-root: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Check out the latest version of the code | |
| - uses: actions/checkout@v4 | |
| # Checks the status of hyperlinks in *.md files in the repo root | |
| - uses: gaurav-nelson/github-action-markdown-link-check@1.0.15 | |
| with: | |
| folder-path: '.' | |
| max-depth: 1 | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Check out the latest version of the code | |
| - uses: actions/checkout@v4 | |
| # Checks the status of hyperlinks in *.md files in the docs/docs folder, | |
| # as well as various explicitly listed files throughout the repo. | |
| # We don't use this to check the repo root, since there we want to use max-depth=1. | |
| - uses: gaurav-nelson/github-action-markdown-link-check@1.0.15 | |
| with: | |
| folder-path: 'docs/docs' | |
| file-path: 'tests/e2e/README.md' |