Skip to content

Commit 859188d

Browse files
Fix Vale style errors in instance audiences documentation
- Replace audience(s) with audiences for clarity - Change 'does not' to 'doesn't' per Microsoft.Contractions - Capitalize 'API Reference' per FernStyles.Reject - Replace 'Latest/latest' version names with v3/v2 to avoid time-relative terms Co-Authored-By: Catherine Deskur <[email protected]>
1 parent 96c79d0 commit 859188d

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

fern/products/docs/pages/navigation/instance-audiences.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@ Instance audiences allow you to control which versions and products are included
1111

1212
You can add audiences to three levels in your `docs.yml` configuration:
1313

14-
1. **Instances** - Define which audience(s) an instance serves
15-
2. **Versions** - Tag versions with audience(s) they belong to
16-
3. **Products** - Tag products with audience(s) they belong to
14+
1. **Instances** - Define which audiences an instance serves
15+
2. **Versions** - Tag versions with audiences they belong to
16+
3. **Products** - Tag products with audiences they belong to
1717

18-
When you add an audience to a product or version and it matches the audience of the instance, that content will be included. If the audience is defined but does not match the instance audience, it will be excluded. If no audience is defined, all content will be included by default.
18+
When you add an audience to a product or version and it matches the audience of the instance, that content will be included. If the audience is defined but doesn't match the instance audience, it will be excluded. If no audience is defined, all content will be included by default.
1919

2020
## Configuration
2121

2222
### Add audiences to instances
2323

24-
Define which audience(s) an instance serves by adding the `audiences` property to an instance in your `docs.yml`:
24+
Define which audiences an instance serves by adding the `audiences` property to an instance in your `docs.yml`:
2525

2626
<CodeBlock title="docs.yml">
2727
```yaml {3-4}
@@ -42,12 +42,12 @@ Tag versions with audiences to control which instances include them:
4242
<CodeBlock title="docs.yml">
4343
```yaml {4-5, 8-9}
4444
versions:
45-
- display-name: Latest
46-
path: ./versions/latest.yml
45+
- display-name: v3
46+
path: ./versions/v3.yml
4747
audiences:
4848
- public
49-
- display-name: Beta
50-
path: ./versions/beta.yml
49+
- display-name: v2
50+
path: ./versions/v2.yml
5151
audiences:
5252
- internal
5353
- beta
@@ -79,7 +79,7 @@ products:
7979
The filtering logic works as follows:
8080
8181
- **Match**: If a version or product has an audience defined that matches the instance audience, it will be included
82-
- **No match**: If a version or product has an audience defined that does not match the instance audience, it will be excluded
82+
- **No match**: If a version or product has an audience defined that doesn't match the instance audience, it will be excluded
8383
- **No audience defined**: If no audience is defined on a version or product, it will be included in all instances
8484
8585
## Example configuration
@@ -158,11 +158,11 @@ fern docs publish --instance docs.plantstore.com
158158
fern docs publish --instance internal.plantstore.docs.buildwithfern.com
159159
```
160160

161-
## Combining with API reference audiences
161+
## Combining with API Reference audiences
162162

163-
Instance audiences work alongside [API reference audiences](/docs/api-references/audiences), which filter endpoints and schemas within your API documentation. You can use both features together:
163+
Instance audiences work alongside [API Reference audiences](/docs/api-references/audiences), which filter endpoints and schemas within your API documentation. You can use both features together:
164164

165165
- **Instance audiences** - Control which products and versions appear in each instance
166-
- **API reference audiences** - Control which endpoints and schemas appear within API references
166+
- **API Reference audiences** - Control which endpoints and schemas appear within API References
167167

168-
For example, you might have a public instance that includes only public products, and within those products, the API references are further filtered to show only public endpoints.
168+
For example, you might have a public instance that includes only public products, and within those products, the API References are further filtered to show only public endpoints.

0 commit comments

Comments
 (0)