diff --git a/fern/docs/pages/learn/docs/getting-started/page-in-getting-started.mdx b/fern/docs/pages/learn/docs/getting-started/page-in-getting-started.mdx new file mode 100644 index 000000000..85285dec3 --- /dev/null +++ b/fern/docs/pages/learn/docs/getting-started/page-in-getting-started.mdx @@ -0,0 +1,5 @@ +--- +title: Page in Getting started +slug: learn/docs/getting-started/page-in-getting-started +--- + diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml index dc898fec9..feac991d0 100644 --- a/fern/products/docs/docs.yml +++ b/fern/products/docs/docs.yml @@ -11,6 +11,8 @@ navigation: path: ./pages/getting-started/project-structure.mdx - link: Customer showcase href: https://buildwithfern.com/showcase#docs-customers.alldocs-features + - page: Page in Getting started + path: docs/pages/learn/docs/getting-started/page-in-getting-started.mdx - changelog: ./pages/changelog icon: fa-regular fa-clock-rotate-left - section: Configuration @@ -19,6 +21,9 @@ navigation: path: ./pages/customization/what-is-docs-yml.mdx - page: Navigation path: ./pages/navigation/overview.mdx + - page: Tabs and tab variants + path: ./pages/navigation/tabs.mdx + slug: tabs - page: Versions path: ./pages/navigation/versions.mdx - page: Products @@ -35,75 +40,81 @@ navigation: - page: Overview path: ./pages/component-library/default-components/overview.mdx icon: fa-duotone fa-book - - page: Accordions + - page: Accordion path: ./pages/component-library/default-components/accordions.mdx icon: fa-duotone fa-chevron-down - - page: Accordion Groups - path: ./pages/component-library/default-components/accordion-groups.mdx - icon: fa-duotone fa-chevrons-down + slug: accordions - page: Anchor path: ./pages/component-library/default-components/anchor.mdx icon: fa-duotone fa-link - page: Aside path: ./pages/component-library/default-components/aside.mdx icon: fa-regular fa-comment-dots - - page: Badges + - page: Badge path: ./pages/component-library/default-components/badges.mdx icon: fa-regular fa-ribbon + slug: badges - page: Button path: ./pages/component-library/default-components/button.mdx icon: fa-duotone fa-arrow-pointer - - page: Callouts + - page: Callout path: ./pages/component-library/default-components/callouts.mdx icon: fa-duotone fa-exclamation-triangle - - page: Cards + slug: callouts + - page: Card path: ./pages/component-library/default-components/cards.mdx icon: fa-duotone fa-id-card - - page: Card Groups - path: ./pages/component-library/default-components/card-groups.mdx - icon: fa-duotone fa-grid-2 - - page: Code Blocks + slug: cards + - page: Code block path: ./pages/component-library/default-components/code-blocks.mdx icon: fa-duotone fa-code + slug: code-blocks - page: Embed path: ./pages/component-library/default-components/embed.mdx icon: fa-duotone fa-window-restore - - page: Endpoint Request Snippet + - page: Endpoint request snippet path: ./pages/component-library/default-components/endpoint-request-snippet.mdx icon: fa-duotone fa-arrow-up slug: request-snippet - - page: Endpoint Response Snippet + - page: Endpoint response snippet path: ./pages/component-library/default-components/endpoint-response-snippet.mdx icon: fa-duotone fa-arrow-down slug: response-snippet - - page: Endpoint Schema Snippet + - page: Endpoint schema snippet path: ./pages/component-library/default-components/endpoint-schema-snippet.mdx icon: fa-duotone fa-sitemap slug: schema-snippet - - page: Runnable Endpoint - path: ./pages/component-library/default-components/runnable-endpoint.mdx - icon: fa-duotone fa-play-circle - - page: Frames + - page: Frame path: ./pages/component-library/default-components/frames.mdx icon: fa-duotone fa-window-maximize - - page: Icons + slug: frames + - page: Icon path: ./pages/component-library/default-components/icons.mdx icon: fa-duotone fa-icons - - page: Parameter Fields + slug: icons + - page: Parameter field path: ./pages/component-library/default-components/parameter-fields.mdx icon: fa-duotone fa-list - - page: Steps + slug: parameter-fields + - page: Runnable endpoint + path: ./pages/component-library/default-components/runnable-endpoint.mdx + icon: fa-duotone fa-play-circle + - page: Step path: ./pages/component-library/default-components/steps.mdx icon: fa-duotone fa-list-ol - - page: Sticky tables + slug: steps + - page: Sticky table path: ./pages/component-library/default-components/sticky-tables.mdx icon: fa-duotone fa-table - - page: Tabs + slug: sticky-tables + - page: Tab path: ./pages/component-library/default-components/tabs.mdx icon: fa-duotone fa-folder-open - - page: Tooltips + slug: tabs + - page: Tooltip path: ./pages/component-library/default-components/tooltips.mdx icon: fa-duotone fa-comment + slug: tooltips - page: Fern Editor path: ./pages/component-library/writing-content/visual-editor.mdx slug: fern-editor @@ -130,7 +141,7 @@ navigation: - section: Preview & publish collapsed: true contents: - - page: Previewing changes locally + - page: Previewing changes locally path: ./pages/getting-started/preview-changes-locally.mdx - page: Previewing changes in a PR path: ./pages/getting-started/pr-preview.mdx @@ -153,6 +164,13 @@ navigation: path: ./pages/customization/user-feedback.mdx - page: Custom CSS & JS path: ./pages/component-library/custom-components/custom-css-js.mdx + - section: Accessibility + collapsed: true + contents: + - page: Overview + path: ./pages/accessibility/overview.mdx + - page: Keyboard shortcuts + path: ./pages/accessibility/keyboard-shortcuts.mdx - section: API references collapsed: true contents: @@ -218,9 +236,9 @@ navigation: path: ./pages/api-references/autopopulate-api-key.mdx - page: SSO path: ./pages/authentication/sso.mdx - - section: Self-hosted - collapsed: true - contents: + - section: Self-hosted + collapsed: true + contents: - page: Overview path: ./pages/enterprise/self-hosted.mdx - page: Set up self-hosted documentation @@ -253,7 +271,7 @@ navigation: slug: analytics/mixpanel - page: Postman path: ./pages/integrations/postman.mdx - - page: LaunchDarkly feature flags + - page: LaunchDarkly feature flags path: ./pages/integrations/feature-flags.mdx hidden: true - section: Developer tools @@ -266,7 +284,6 @@ navigation: - page: GitLab path: ./pages/developer-tools/gitlab.mdx - page: Vale - path: ./pages/developer-tools/vale.mdx + path: ./pages/developer-tools/vale.mdx - page: View Markdown path: ./pages/developer-tools/view-markdown.mdx - \ No newline at end of file diff --git a/fern/products/docs/pages/getting-started/how-it-works.mdx b/fern/products/docs/pages/getting-started/how-it-works.mdx index 5f5bee683..0311baf37 100644 --- a/fern/products/docs/pages/getting-started/how-it-works.mdx +++ b/fern/products/docs/pages/getting-started/how-it-works.mdx @@ -7,6 +7,8 @@ Fern combines your API specifications, static Markdown files (like how-to guides This process is built around two major workflows: **editing** and **deploying** your documentation. +EDITS FROM STAGING! + This diagram shows the technical infrastructure that powers the documentation generation process. @@ -77,8 +79,8 @@ flowchart TD You can update your documentation in two ways: -- **Direct editing**: Open a pull request directly in the [GitHub repository that contains your docs](/learn/docs/getting-started/project-structure) (including your `docs.yml` configuration and Markdown files). -- **Fern Editor**: Use the [Fern Editor](/learn/docs/writing-content/fern-editor) to modify your docs without touching code. The Fern GitHub App fetches the current state from your docs repository and passes it to the Fern Editor. When you submit changes, the Fern GitHub App automatically opens a pull request for review. +- **Direct editing**: Open a pull request directly in the [GitHub repository that contains your docs](/learn/docs/getting-started/project-structure) (including your `docs.yml` configuration and Markdown files). +- **Fern Editor**: Use the [Fern Editor](/learn/docs/writing-content/fern-editor) to modify your docs without touching code. The Fern GitHub App fetches the current state from your docs repository and passes it to the Fern Editor. When you submit changes, the Fern GitHub App automatically opens a pull request for review. After the update goes through your review process, an approver can merge it.