Skip to content

Commit a641b8f

Browse files
Kapil GowruKapil Gowru
authored andcommitted
feat: working on docs home
1 parent 47b772d commit a641b8f

File tree

23 files changed

+495
-110
lines changed

23 files changed

+495
-110
lines changed

card-group-example.mdx

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<CardGroup cols={2}>
2+
<Card title="Quickstart">
3+
Start building beautiful documentation in under 5 minutes.
4+
</Card>
5+
6+
<Card title="Configure with ease">
7+
One simple file that can be used to generate documentation that fits your brand.
8+
</Card>
9+
10+
<Card title="Flexible component library">
11+
Use pre-built or custom React components for a polished look.
12+
</Card>
13+
14+
<Card title="Visual Editor">
15+
Modify your documentation without touching code and publish to your GitHub.
16+
</Card>
17+
</CardGroup>

fern/products/docs/docs.yml

Lines changed: 65 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,79 @@ navigation:
55
path: ./pages/guides/getting-started/overview.mdx
66
- page: Quickstart
77
path: ./pages/guides/getting-started/quickstart.mdx
8-
- page: Migrate from an existing site
8+
- page: Migrating from an existing site
99
path: ./pages/guides/getting-started/migrate-from-existing-site.mdx
10+
- page: Previewing your docs
11+
path: ./pages/guides/getting-started/setting-up-your-domain.mdx
1012
- page: Setting up your domain
1113
path: ./pages/guides/getting-started/setting-up-your-domain.mdx
1214
- page: Customer Showcase
1315
path: ./pages/guides/getting-started/customer-showcase.mdx
14-
- section: Reference
16+
- section: Component Library
17+
contents:
18+
- page: Overview
19+
path: ./pages/component-library/overview.mdx
20+
- section: Writing Content
21+
contents:
22+
- page: Markdown
23+
path: ./pages/component-library/writing-content/markdown.mdx
24+
- page: Frontmatter
25+
path: ./pages/component-library/writing-content/frontmatter.mdx
26+
- page: Visual Editor
27+
path: ./pages/component-library/writing-content/visual-editor.mdx
28+
- section: Default Components
29+
contents:
30+
- page: Overview
31+
path: ./pages/component-library/default-components/overview.mdx
32+
- page: Accordions
33+
path: ./pages/component-library/default-components/accordions.mdx
34+
- page: Accordion Groups
35+
path: ./pages/component-library/default-components/accordion-groups.mdx
36+
- page: Aside
37+
path: ./pages/component-library/default-components/aside.mdx
38+
- page: Callouts
39+
path: ./pages/component-library/default-components/callouts.mdx
40+
- page: Cards
41+
path: ./pages/component-library/default-components/cards.mdx
42+
- page: Card Groups
43+
path: ./pages/component-library/default-components/card-groups.mdx
44+
- page: Code Blocks
45+
path: ./pages/component-library/default-components/code-blocks.mdx
46+
- page: Embed
47+
path: ./pages/component-library/default-components/embed.mdx
48+
- page: Endpoint Request Snippet
49+
path: ./pages/component-library/default-components/endpoint-request-snippet.mdx
50+
- page: Endpoint Response Snippet
51+
path: ./pages/component-library/default-components/endpoint-response-snippet.mdx
52+
- page: Endpoint Schema Snippet
53+
path: ./pages/component-library/default-components/endpoint-schema-snippet.mdx
54+
- page: Frames
55+
path: ./pages/component-library/default-components/frames.mdx
56+
- page: Icons
57+
path: ./pages/component-library/default-components/icons.mdx
58+
- page: Parameter Fields
59+
path: ./pages/component-library/default-components/parameter-fields.mdx
60+
- page: Steps
61+
path: ./pages/component-library/default-components/steps.mdx
62+
- page: Tabs
63+
path: ./pages/component-library/default-components/tabs.mdx
64+
- page: Tooltips
65+
path: ./pages/component-library/default-components/tooltips.mdx
66+
- section: Custom Components
67+
contents:
68+
- page: Reusable Snippets
69+
path: ./pages/component-library/custom-components/reusable-snippets.mdx
70+
- page: Custom React Components
71+
path: ./pages/component-library/custom-components/custom-react-components.mdx
72+
- section: Configuration
1573
collapsed: true
1674
contents:
1775
- page: What is docs.yml
18-
path: ./pages/guides/reference/what-is-docs-yml.mdx
76+
path: ./pages/guides/configuration/what-is-docs-yml.mdx
77+
- page: Project Structure
78+
path: ./pages/guides/configuration/project-structure.mdx
1979
- page: Frontmatter
20-
path: ./pages/guides/reference/frontmatter.mdx
80+
path: ./pages/guides/configuration/frontmatter.mdx
2181
- section: Navigation
2282
collapsed: true
2383
contents:
@@ -45,7 +105,7 @@ navigation:
45105
- page: SEO Metadata
46106
path: ./pages/guides/seo/seo-metadata.mdx
47107
- page: Ilms.txt
48-
path: ./pages/guides/seo/ilms-txt.mdx
108+
path: ./pages/guides/seo/llms-txt.mdx
49109
- section: Authentication
50110
collapsed: true
51111
contents:
@@ -83,62 +143,6 @@ navigation:
83143
path: ./pages/guides/integrations/feature-flags.mdx
84144
- page: Self-hosted
85145
path: ./pages/guides/integrations/self-hosted.mdx
86-
- section: Component Library
87-
contents:
88-
- page: Overview
89-
path: ./pages/component-library/overview.mdx
90-
- section: Writing Content
91-
contents:
92-
- page: Markdown
93-
path: ./pages/component-library/writing-content/markdown.mdx
94-
- page: Frontmatter
95-
path: ./pages/component-library/writing-content/frontmatter.mdx
96-
- page: Visual Editor
97-
path: ./pages/component-library/writing-content/visual-editor.mdx
98-
- section: Default Components
99-
contents:
100-
- page: Overview
101-
path: ./pages/component-library/default-components/overview.mdx
102-
- page: Accordions
103-
path: ./pages/component-library/default-components/accordions.mdx
104-
- page: Accordion Groups
105-
path: ./pages/component-library/default-components/accordion-groups.mdx
106-
- page: Aside
107-
path: ./pages/component-library/default-components/aside.mdx
108-
- page: Callouts
109-
path: ./pages/component-library/default-components/callouts.mdx
110-
- page: Cards
111-
path: ./pages/component-library/default-components/cards.mdx
112-
- page: Card Groups
113-
path: ./pages/component-library/default-components/card-groups.mdx
114-
- page: Code Blocks
115-
path: ./pages/component-library/default-components/code-blocks.mdx
116-
- page: Embed
117-
path: ./pages/component-library/default-components/embed.mdx
118-
- page: Endpoint Request Snippet
119-
path: ./pages/component-library/default-components/endpoint-request-snippet.mdx
120-
- page: Endpoint Response Snippet
121-
path: ./pages/component-library/default-components/endpoint-response-snippet.mdx
122-
- page: Endpoint Schema Snippet
123-
path: ./pages/component-library/default-components/endpoint-schema-snippet.mdx
124-
- page: Frames
125-
path: ./pages/component-library/default-components/frames.mdx
126-
- page: Icons
127-
path: ./pages/component-library/default-components/icons.mdx
128-
- page: Parameter Fields
129-
path: ./pages/component-library/default-components/parameter-fields.mdx
130-
- page: Steps
131-
path: ./pages/component-library/default-components/steps.mdx
132-
- page: Tabs
133-
path: ./pages/component-library/default-components/tabs.mdx
134-
- page: Tooltips
135-
path: ./pages/component-library/default-components/tooltips.mdx
136-
- section: Custom Components
137-
contents:
138-
- page: Reusable Snippets
139-
path: ./pages/component-library/custom-components/reusable-snippets.mdx
140-
- page: Custom React Components
141-
path: ./pages/component-library/custom-components/custom-react-components.mdx
142146
- page: Changelog
143147
path: ./pages/changelog/overview.mdx
144148

File renamed without changes.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Project Structure
3+
---
4+
5+
Learn about the recommended project structure and organization for your Fern documentation.
6+
7+
<Warning>This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview).</Warning>
File renamed without changes.
245 KB
Loading
183 KB
Loading
214 KB
Loading
226 KB
Loading
Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,26 @@
11
---
2-
title: Overview
2+
title: Documentation
3+
description: Meet documentation that is stunning by default, AI-ready, and designed to convert.
34
---
45

5-
Welcome to the Getting Started guide! This page provides an introduction to setting up and using your documentation site.
6-
7-
<Warning>This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview).</Warning>
6+
<CardGroup cols={2}>
7+
<Card title="Quickstart">
8+
<Image src="/images/quickstart.png" alt="Quickstart" />
9+
Start building beautiful documentation in under 5 minutes.
10+
</Card>
11+
12+
<Card title="Configure with ease">
13+
<Image src="/images/configure.png" alt="Configure with ease" />
14+
One simple file that can be used to generate documentation that fits your brand.
15+
</Card>
16+
17+
<Card title="Flexible component library">
18+
<Image src="/images/component-library.png" alt="Flexible component library" />
19+
Use pre-built or custom React components for a polished look.
20+
</Card>
21+
22+
<Card title="Visual Editor">
23+
<Image src="/images/visual-editor.png" alt="Visual Editor" />
24+
Modify your documentation without touching code and publish to your GitHub.
25+
</Card>
26+
</CardGroup>

0 commit comments

Comments
 (0)