Skip to content

Commit 689f367

Browse files
authored
chore: fix too-short meta descriptions for better seo (#2962)
1 parent 6550098 commit 689f367

File tree

18 files changed

+24
-22
lines changed

18 files changed

+24
-22
lines changed

fern/products/api-def/asyncapi-pages/channels/pubsub.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Publish/Subscribe Operations
3-
subtitle: Document event-driven APIs with publish and subscribe operations
3+
description: Define AsyncAPI publish/subscribe operations for event-driven APIs. Step-by-step tutorial with message examples and bi-directional channels.
44
---
55

66
Operations in AsyncAPI are defined underneath the `operations` key, with channels defined under the `channels` key. Below is an example of defining publish and subscribe operations:

fern/products/api-def/asyncapi-pages/extensions/examples.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Request + response examples
3-
description: Provide additional examples for better SDK documentation using `x-fern-examples` extension
3+
description: Add message examples to AsyncAPI specs with `x-fern-examples`. Improve SDK documentation with real-world payload examples.
4+
og:title: AsyncAPI request + response examples
45
---
56

67
Provide additional examples for better SDK documentation:

fern/products/api-def/asyncapi-pages/extensions/server-name.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Server names
3-
description: Specify custom names for servers using `x-fern-server-name` extension
3+
description: Configure custom server names in AsyncAPI specifications with `x-fern-server-name` extension. Set up production and staging server labels.
44
---
55

66
Specify custom names for servers:

fern/products/api-def/ferndef-pages/auth.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Authentication
3-
subtitle: Model auth schemes such as bearer, basic, custom headers, and oauth.
3+
description: Configure API authentication in Fern Definition. Set up bearer tokens, basic auth, custom headers, and OAuth for your API endpoints.
44
---
55

66
Configuring authentication schemes happens in the `api.yml` file. All Fern-generated SDKs support both direct configuration and environment variables for authentication credentials.

fern/products/api-def/ferndef-pages/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: What is a Fern Definition?
3-
description: "A Fern Definition is a set of YAML files that describe your API."
3+
description: Fern Definition is a YAML format for API specifications. Define your REST API endpoints, data models, and errors in one source of truth.
44
---
55

66
A Fern Definition is a set of YAML files that are the single source of truth for your API. You check your Fern Definition into your repo,

fern/products/api-def/grpc-pages/automation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Sync your gRPC specification
3-
subtitle: Automatically sync your Protocol Buffer changes to keep SDKs and docs up to date
3+
description: Automate gRPC specification syncing with Fern. Set up GitHub Actions, CI/CD pipelines, and scheduled updates for Protocol Buffer files.
44
---
55

66
Keeping your gRPC specifications in sync with your codebase is crucial for maintaining accurate SDKs and documentation. Fern provides several automation options to streamline this process.

fern/products/api-def/grpc-pages/reference/generators-reference.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: gRPC generators.yml reference
3-
description: Reference for configuring gRPC specifications in your generators.yml file
3+
description: Complete gRPC generators.yml reference guide for Fern. Learn how to configure root, target, overrides, and local-generation settings.
44
---
55

66
The `generators.yml` file serves two roles: it declares your gRPC specification location (in the `api.specs` section), and configures SDK generation (in the optional `groups` section).

fern/products/api-def/openapi-pages/extensions/availability.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Availability
3-
description: Mark endpoint availability status using `x-fern-availability` extension
3+
description: Mark API endpoint availability in OpenAPI with `x-fern-availability`. Set beta, deprecated, stable, etc. statuses for endpoints and sections.
44
---
55

66
The `x-fern-availability` extension is used to mark the availability of an endpoint within your OpenAPI definition. The availability information propagates into the generated Fern Docs website as visual tags.

fern/products/api-def/openapi-pages/extensions/base-path.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
22
title: Base path
3-
description: Configure base path prepended to endpoints using `x-fern-base-path` extension
3+
description: Configure base paths in OpenAPI with `x-fern-base-path`. Set up endpoint prefixes like /v1 for your API definitions with Fern.
44
---
5-
## Base path
65

7-
The `x-fern-base-path` extension is used to configure the base path prepended to every endpoint.
6+
Use the `x-fern-base-path` extension to configure the base path prepended to every endpoint.
87

9-
In the example below, we have configured the `/v1` base path so the full endpoint path is
8+
The example below configures the `/v1` base path so the full endpoint path is
109
`https://api.example.com/v1/users`.
1110

1211
```yaml title="Set the base path in openapi.yml" {1}

fern/products/api-def/openapi-pages/extensions/enums.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Enum descriptions and names
3-
description: Add descriptions and custom names to enum values using `x-fern-enum` extension
3+
description: Add descriptions to OpenAPI enum values with `x-fern-enum` extension. Customize enum names for cleaner SDK code and better documentation.
44
---
55

66
OpenAPI doesn't natively support adding descriptions to enum values. To do this in Fern you can use the `x-fern-enum`

0 commit comments

Comments
 (0)