Skip to content

Commit

Permalink
fix(docs): broken links (#4562)
Browse files Browse the repository at this point in the history
* fix(docs): broken links

* fix link
  • Loading branch information
dannysheridan authored Sep 6, 2024
1 parent 4467249 commit af5350c
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 10 deletions.
3 changes: 2 additions & 1 deletion fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,8 @@ navigation:
slug: analytics
contents:
- page: PostHog
path: ./pages/docs/integrations/analytics/posthog.mdx
path: ./pages/docs/integrations/analytics/posthog.mdx
slug: posthog
- page: Fullstory
path: ./pages/docs/integrations/analytics/fullstory.mdx
- page: Segment
Expand Down
14 changes: 8 additions & 6 deletions fern/pages/api-definition/fern-definition/endpoints.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,18 +61,20 @@ The full path for the endpoint is the concatenation of:

## Display name

The display name will appear as the title of an endpoint [like this one](https://buildwithfern.com/learn/cli-api/api-reference/docs/generate). By default, the display name is equal to the 'Title Case' of the endpoint name. If you would like to customize the endpoint name, you can **set the display name**.
The display name will appear as the title of an endpoint. By default, the display name is equal to the 'Title Case' of the endpoint name. If you would like to customize the endpoint name, you can **set the display name**.

In the example below, ["Create User"](https://plantstore.dev/api-reference/user/create-user) displays as the title of the endpoint page within the API Reference.

<CodeBlock title="user.yml">
```yaml {7}
service:
base-path: /users
base-path: /
auth: false
endpoints:
getAllUsers:
path: /all
display-name: Retrieve All Users
method: GET
createUser:
path: /user
display-name: Create user
method: POST
```
</CodeBlock>

Expand Down
2 changes: 1 addition & 1 deletion fern/pages/docs/building-your-docs/custom-css-js.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ css:
<Note>
For customizing the background, logo, font, and layout of your Docs via Fern's built-in styling,
check out [Customize Styling](/learn/docs/building-your-docs/customize-styling).
check out the [Global Configuration](learn/docs/getting-started/global-configuration).
</Note>
## Custom JavaScript
Expand Down
1 change: 0 additions & 1 deletion fern/pages/docs/integrations/analytics/posthog.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: PostHog
description: Learn how to integrate PostHog with Fern Docs!
slug: posthog
---

## Add Posthog to your Docs
Expand Down
2 changes: 1 addition & 1 deletion fern/pages/docs/writing-content/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ View an example of a changelog per API in [Astronomer's docs](https://www.astron

## Write a Changelog Entry

Create a new changelog entry by writing a Markdown file. You can use `.md` or `.mdx` files. The benefit of using `.mdx` is that you can leverage the built-in [component library](../components/overview.mdx) within an entry.
Create a new changelog entry by writing a Markdown file. You can use `.md` or `.mdx` files. The benefit of using `.mdx` is that you can leverage the built-in [component library](/learn/docs/content/components/overview) within an entry.

<CodeBlock title = "fern/openapi/changelog/2024-07-31.mdx">
```mdx
Expand Down

0 comments on commit af5350c

Please sign in to comment.