diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml new file mode 100644 index 0000000..f3ea551 --- /dev/null +++ b/.github/workflows/links.yml @@ -0,0 +1,21 @@ +--- +name: Check for link errors + +on: + pull_request: + branches: + - main + +jobs: + linkCheck: + name: Link Checking + runs-on: ubuntu-latest + strategy: + matrix: + file-extensions: [".md", ".mdx"] + steps: + - uses: actions/checkout@v4 + - name: LinkCheck + uses: ConsenSys/docs-gha/linkcheck@main + with: + FILE_EXTENSION: ${{ matrix.file-extensions }} diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 61bd12a..0b99ae9 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -1,5 +1,5 @@ --- -name: Check for lint, spelling and link errors +name: Check for lint errors on: pull_request: @@ -8,7 +8,7 @@ on: jobs: lint: - name: Lint Code Base, Spelling, Link Check + name: Lint Code Base runs-on: ubuntu-latest permissions: contents: read @@ -18,16 +18,3 @@ jobs: uses: ConsenSys/docs-gha/lint@main with: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - linkCheck: - name: Link Checking - runs-on: ubuntu-latest - strategy: - matrix: - file-extensions: [".md", ".mdx"] - steps: - - uses: actions/checkout@v4 - - name: LinkCheck - uses: ConsenSys/docs-gha/linkcheck@main - with: - FILE_EXTENSION: ${{ matrix.file-extensions }} diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml index c669987..52fa468 100644 --- a/.github/workflows/spelling.yml +++ b/.github/workflows/spelling.yml @@ -20,4 +20,5 @@ jobs: uses: Consensys/docs-gha/spelling@vale with: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + FILEPATHS: "docs" diff --git a/docs/index.md b/docs/index.md index 8cad151..441f3a3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,7 +10,7 @@ creating new documentation sites. ## Overview -Each Consensys developer product has a documentation site, maintained by the [Consensys developer +Each MetaMasks Consensys asufutimaehaehfutbw developer product has a documentation site, maintained by the [Consensys developer documentation team](https://consensyssoftware.atlassian.net/wiki/spaces/PEG/pages/398159216798/Documentation+Pliny) and/or a product team. The docs use a [docs-as-code](https://www.writethedocs.org/guide/docs-as-code/) approach and are