From a49af7f40561e53b475addcefc06f6a4e4ca0145 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Mon, 27 Oct 2025 14:46:51 -0400 Subject: [PATCH 1/9] add vale pr check back in --- .github/workflows/vale.yml | 41 +++++++++++++++++++ .../docs/pages/api-references/audiences.mdx | 1 + 2 files changed, 42 insertions(+) create mode 100644 .github/workflows/vale.yml diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml new file mode 100644 index 000000000..c7798ee63 --- /dev/null +++ b/.github/workflows/vale.yml @@ -0,0 +1,41 @@ +name: Vale style check +on: + pull_request: + paths: + - '**.mdx' + - '**.md' + - '.vale/**' + - '.vale.ini' + - '!**/changelog/**' + +jobs: + vale: + runs-on: ubuntu-latest + if: | + github.event.pull_request.user.login != 'fern-support' && + github.event.pull_request.user.login != 'github-actions' + steps: + - uses: actions/checkout@v4 + + - name: Get changed files + id: changed-files + uses: tj-actions/changed-files@v41 + with: + files: | + fern/**/*.md + fern/**/*.mdx + files_ignore: | + **/changelog/** + + - name: Install Vale + if: steps.changed-files.outputs.any_changed == 'true' + run: | + wget https://github.com/errata-ai/vale/releases/download/v3.12.0/vale_3.12.0_Linux_64-bit.tar.gz + tar -xvzf vale_3.12.0_Linux_64-bit.tar.gz + sudo mv vale /usr/local/bin/ + + - name: Run Vale + if: steps.changed-files.outputs.any_changed == 'true' + run: | + vale sync + vale ${{ steps.changed-files.outputs.all_changed_files }} \ No newline at end of file diff --git a/fern/products/docs/pages/api-references/audiences.mdx b/fern/products/docs/pages/api-references/audiences.mdx index d3f9c0300..c565700ef 100644 --- a/fern/products/docs/pages/api-references/audiences.mdx +++ b/fern/products/docs/pages/api-references/audiences.mdx @@ -5,6 +5,7 @@ subtitle: Use audiences to filter the endpoints, schemas, and properties that ar +test change Audiences are a useful tool for segmenting your API for different consumers. Common examples of audiences include `public` and `beta`. You can configure audiences in both [the OpenAPI Specification](/learn/api-definitions/openapi/extensions/audiences) as well as [the Fern Definition](/learn/api-definition/fern/audiences). From f585407caf271d6d769330be5f12a73a313754e7 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Mon, 27 Oct 2025 14:47:15 -0400 Subject: [PATCH 2/9] test --- fern/products/docs/pages/api-references/audiences.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/products/docs/pages/api-references/audiences.mdx b/fern/products/docs/pages/api-references/audiences.mdx index c565700ef..9521a8f1d 100644 --- a/fern/products/docs/pages/api-references/audiences.mdx +++ b/fern/products/docs/pages/api-references/audiences.mdx @@ -5,7 +5,7 @@ subtitle: Use audiences to filter the endpoints, schemas, and properties that ar -test change +test change please Audiences are a useful tool for segmenting your API for different consumers. Common examples of audiences include `public` and `beta`. You can configure audiences in both [the OpenAPI Specification](/learn/api-definitions/openapi/extensions/audiences) as well as [the Fern Definition](/learn/api-definition/fern/audiences). From 7ff424a1551a08296e34e542f71580a75e147133 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Mon, 27 Oct 2025 14:51:31 -0400 Subject: [PATCH 3/9] test --- .github/workflows/vale.yml | 19 ++++++++----------- .../docs/pages/api-references/audiences.mdx | 2 +- 2 files changed, 9 insertions(+), 12 deletions(-) diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml index c7798ee63..98337957e 100644 --- a/.github/workflows/vale.yml +++ b/.github/workflows/vale.yml @@ -27,15 +27,12 @@ jobs: files_ignore: | **/changelog/** - - name: Install Vale + - uses: errata-ai/vale-action@reviewdog if: steps.changed-files.outputs.any_changed == 'true' - run: | - wget https://github.com/errata-ai/vale/releases/download/v3.12.0/vale_3.12.0_Linux_64-bit.tar.gz - tar -xvzf vale_3.12.0_Linux_64-bit.tar.gz - sudo mv vale /usr/local/bin/ - - - name: Run Vale - if: steps.changed-files.outputs.any_changed == 'true' - run: | - vale sync - vale ${{ steps.changed-files.outputs.all_changed_files }} \ No newline at end of file + with: + files: ${{ steps.changed-files.outputs.all_changed_files }} + version: 3.12.0 + reporter: github-pr-review + fail_on_error: false + env: + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} \ No newline at end of file diff --git a/fern/products/docs/pages/api-references/audiences.mdx b/fern/products/docs/pages/api-references/audiences.mdx index 9521a8f1d..2715d380e 100644 --- a/fern/products/docs/pages/api-references/audiences.mdx +++ b/fern/products/docs/pages/api-references/audiences.mdx @@ -5,7 +5,7 @@ subtitle: Use audiences to filter the endpoints, schemas, and properties that ar -test change please +test change please please check Audiences are a useful tool for segmenting your API for different consumers. Common examples of audiences include `public` and `beta`. You can configure audiences in both [the OpenAPI Specification](/learn/api-definitions/openapi/extensions/audiences) as well as [the Fern Definition](/learn/api-definition/fern/audiences). From 8120dd0276b438b45c9e7c6655cf9887e27d035b Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Mon, 27 Oct 2025 14:53:43 -0400 Subject: [PATCH 4/9] fix vale errors --- fern/products/docs/pages/api-references/audiences.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/fern/products/docs/pages/api-references/audiences.mdx b/fern/products/docs/pages/api-references/audiences.mdx index 2715d380e..d3f9c0300 100644 --- a/fern/products/docs/pages/api-references/audiences.mdx +++ b/fern/products/docs/pages/api-references/audiences.mdx @@ -5,7 +5,6 @@ subtitle: Use audiences to filter the endpoints, schemas, and properties that ar -test change please please check Audiences are a useful tool for segmenting your API for different consumers. Common examples of audiences include `public` and `beta`. You can configure audiences in both [the OpenAPI Specification](/learn/api-definitions/openapi/extensions/audiences) as well as [the Fern Definition](/learn/api-definition/fern/audiences). From 33ebcfab0abef357bcc0fe5efa32c5c54aff4669 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Mon, 27 Oct 2025 14:56:29 -0400 Subject: [PATCH 5/9] Test --- .github/workflows/vale.yml | 2 +- .vale.ini | 1 + fern/products/docs/pages/api-references/audiences.mdx | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml index 98337957e..b4d6acb33 100644 --- a/.github/workflows/vale.yml +++ b/.github/workflows/vale.yml @@ -32,7 +32,7 @@ jobs: with: files: ${{ steps.changed-files.outputs.all_changed_files }} version: 3.12.0 - reporter: github-pr-review + reporter: github-pr-check fail_on_error: false env: GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} \ No newline at end of file diff --git a/.vale.ini b/.vale.ini index 46c368d0f..c3787ee06 100644 --- a/.vale.ini +++ b/.vale.ini @@ -22,6 +22,7 @@ Microsoft.Vocab = NO Microsoft.Semicolon = NO # Mostly just picks up code Microsoft.SentenceLength = NO # Mostly just picks up code Microsoft.Dashes = NO +Microsoft.Foreign = NO # Not relevant for Fern audience Microsoft.GeneralURL = NO diff --git a/fern/products/docs/pages/api-references/audiences.mdx b/fern/products/docs/pages/api-references/audiences.mdx index d3f9c0300..3cc8a0818 100644 --- a/fern/products/docs/pages/api-references/audiences.mdx +++ b/fern/products/docs/pages/api-references/audiences.mdx @@ -5,6 +5,7 @@ subtitle: Use audiences to filter the endpoints, schemas, and properties that ar +please testing Audiences are a useful tool for segmenting your API for different consumers. Common examples of audiences include `public` and `beta`. You can configure audiences in both [the OpenAPI Specification](/learn/api-definitions/openapi/extensions/audiences) as well as [the Fern Definition](/learn/api-definition/fern/audiences). From 6c01da6c0403a76c248261734c751d3b5bfe0d6b Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Mon, 27 Oct 2025 15:08:48 -0400 Subject: [PATCH 6/9] change --- .github/workflows/vale.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml index b4d6acb33..98337957e 100644 --- a/.github/workflows/vale.yml +++ b/.github/workflows/vale.yml @@ -32,7 +32,7 @@ jobs: with: files: ${{ steps.changed-files.outputs.all_changed_files }} version: 3.12.0 - reporter: github-pr-check + reporter: github-pr-review fail_on_error: false env: GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} \ No newline at end of file From 8b861bdfc182dcc345454e17f0a1bf655f940bd3 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Mon, 27 Oct 2025 15:49:11 -0400 Subject: [PATCH 7/9] revert testing file --- fern/products/docs/pages/api-references/audiences.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/fern/products/docs/pages/api-references/audiences.mdx b/fern/products/docs/pages/api-references/audiences.mdx index 3cc8a0818..d3f9c0300 100644 --- a/fern/products/docs/pages/api-references/audiences.mdx +++ b/fern/products/docs/pages/api-references/audiences.mdx @@ -5,7 +5,6 @@ subtitle: Use audiences to filter the endpoints, schemas, and properties that ar -please testing Audiences are a useful tool for segmenting your API for different consumers. Common examples of audiences include `public` and `beta`. You can configure audiences in both [the OpenAPI Specification](/learn/api-definitions/openapi/extensions/audiences) as well as [the Fern Definition](/learn/api-definition/fern/audiences). From 0975aee13243f100cf7901370dbecf1e28d76037 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Mon, 27 Oct 2025 15:51:08 -0400 Subject: [PATCH 8/9] test changelog file --- fern/products/docs/pages/changelog/2024-01-24.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/fern/products/docs/pages/changelog/2024-01-24.mdx b/fern/products/docs/pages/changelog/2024-01-24.mdx index 99121ed22..2441e27cb 100644 --- a/fern/products/docs/pages/changelog/2024-01-24.mdx +++ b/fern/products/docs/pages/changelog/2024-01-24.mdx @@ -4,6 +4,8 @@ Enable interactive API testing directly in the documentation. - Improved error handling and status code display - Added support for recursive property rendering +test please + ## Enhanced Dark Mode Multiple improvements to dark mode readability for syntax highlighting, dropdowns, and search results. From 7f03f61ee43cb3be68ef33872e415ddff9afc770 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Mon, 27 Oct 2025 15:53:58 -0400 Subject: [PATCH 9/9] revert testing file --- .github/workflows/vale.yml | 3 +-- fern/products/docs/pages/changelog/2024-01-24.mdx | 2 -- 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml index 98337957e..20686f7bd 100644 --- a/.github/workflows/vale.yml +++ b/.github/workflows/vale.yml @@ -16,7 +16,7 @@ jobs: github.event.pull_request.user.login != 'github-actions' steps: - uses: actions/checkout@v4 - + - name: Get changed files id: changed-files uses: tj-actions/changed-files@v41 @@ -26,7 +26,6 @@ jobs: fern/**/*.mdx files_ignore: | **/changelog/** - - uses: errata-ai/vale-action@reviewdog if: steps.changed-files.outputs.any_changed == 'true' with: diff --git a/fern/products/docs/pages/changelog/2024-01-24.mdx b/fern/products/docs/pages/changelog/2024-01-24.mdx index 2441e27cb..99121ed22 100644 --- a/fern/products/docs/pages/changelog/2024-01-24.mdx +++ b/fern/products/docs/pages/changelog/2024-01-24.mdx @@ -4,8 +4,6 @@ Enable interactive API testing directly in the documentation. - Improved error handling and status code display - Added support for recursive property rendering -test please - ## Enhanced Dark Mode Multiple improvements to dark mode readability for syntax highlighting, dropdowns, and search results.