Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(docs): add landing-page to schema #5108

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+20 −0
Open

chore(docs): add landing-page to schema #5108

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ec0eeb7
add landing-page schema
elissa-alarmani Nov 5, 2024
466b234
Merge branch 'main' into elissa-alarmani/add-landing-page
elissa-alarmani Nov 5, 2024
5830eaa
Merge branch 'main' into elissa-alarmani/add-landing-page
dannysheridan Nov 5, 2024
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
20 changes: 20 additions & 0 deletions fern/pages/docs/getting-started/global-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,11 @@ favicon: path/to/favicon.ico
`layout` configuration [here](/learn/docs/getting-started/global-configuration#layout-configuration).
</ParamField>

<ParamField path="landing-page" type="object" required={false}>
Creates a landing page for your documentation website. Learn more about the
`landing-page` configuration [here](/learn/docs/getting-started/global-configuration#landing-page-configuration).
</ParamField>

## Instances configuration

An `instance` is the backend of a distinct docs website. Each instance is published to a unique domain using the `--instance` flag. It is most common to use instances to configure staging and production docs which publish to separate URLs.
Expand Down Expand Up @@ -390,3 +395,18 @@ Be sure the repository is set to **public** visibility.
<ParamField path="github.branch" type="string" required={true}>
The branch of the repository you would like the GitHub editor to open a PR to. Default is `main`.
</ParamField>

## Landing page configuration
Copy link
Member

Choose a reason for hiding this comment

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

@elissa-alarmani think it'd be helpful to link out to Cohere's example that's open source and live in production?

```yaml docs.yml
landing-page:
page: Page Title
path: path/to/landing-page.mdx
```

<ParamField path="page" type="string" required={true}>
The name of the landing page.
</ParamField>

<ParamField path="path" type="string" required={true}>
Relative filepath to the desired landing page Markdown file.
</ParamField>
Loading