Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/workflows/vale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
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/**

- uses: errata-ai/vale-action@reviewdog
if: steps.changed-files.outputs.any_changed == 'true'
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}}
1 change: 1 addition & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/products/docs/pages/api-references/audiences.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ subtitle: Use audiences to filter the endpoints, schemas, and properties that ar

<Markdown src="/snippets/pro-plan.mdx"/>

please testing
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Please] Avoid using 'please' in technical documentation.

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).

Expand Down