Skip to content

Commit 1f59caa

Browse files
committed
upgrade and improve readme
2 parents df82b89 + 0d4151a commit 1f59caa

File tree

4 files changed

+47
-21
lines changed

4 files changed

+47
-21
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,6 @@ Get inspired by API documentation built with Fern: [Webflow](https://developers.
2929
2. Choose the option to **create a new repository**. Name it `fern-docs`.
3030
3. Install the Fern CLI by running:
3131

32-
```bash
33-
npm install -g fern-api
34-
```
35-
3632
### Step 2: Clone and open the repo in your preferred code editor
3733

3834
Clone your newly created repository and open it in your favorite code editor (e.g., Cursor, VS Code).
@@ -49,10 +45,16 @@ Open the `fern.config.json` file and change the organization name:
4945
```json
5046
{
5147
"organization": "your-organization-name",
52-
"version": "0.77.3"
48+
"version": "0.77.4"
5349
}
5450
```
5551

52+
Run the following command to ensure you are using the latest version of Fern:
53+
54+
```bash
55+
fern upgrade
56+
```
57+
5658
**2. Update `docs.yml`:**
5759
Open the `docs.yml` file and update the URL:
5860

fern/docs.yml

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,38 @@ title: Plant Store
99
layout:
1010
searchbar-placement: header
1111
page-width: full
12+
tabs-placement: header
13+
14+
tabs:
15+
home:
16+
display-name: Home
17+
icon: home
18+
guides:
19+
display-name: Guides
20+
icon: book
21+
API Reference:
22+
display-name: API Reference
23+
icon: puzzle
1224

1325
navigation:
14-
- section: Get Started
15-
contents:
16-
- page: Welcome
17-
path: docs/pages/welcome.mdx
18-
- page: Concepts
19-
path: docs/pages/concepts.mdx
20-
- page: SDKs
21-
path: docs/pages/sdks.mdx
22-
slug: sdks
23-
- api: API Reference
26+
- tab: home
27+
layout:
28+
- section: Get Started
29+
contents:
30+
- page: Welcome
31+
path: docs/pages/welcome.mdx
32+
- tab: guides
33+
layout:
34+
- section: Learn
35+
contents:
36+
- page: Concepts
37+
path: docs/pages/concepts.mdx
38+
- page: SDKs
39+
path: docs/pages/sdks.mdx
40+
slug: sdks
41+
- tab: API Reference
42+
layout:
43+
- api: API Reference
2444

2545
navbar-links:
2646
- type: minimal
@@ -31,7 +51,7 @@ navbar-links:
3151
url: https://buildwithfern.com/contact?utm_campaign=demo&utm_medium=plantstore&utm_source=navbar
3252
- type: github
3353
value: https://github.com/fern-api/fern
34-
54+
3555
colors:
3656
accentPrimary:
3757
dark: "#81C784"

fern/docs/pages/welcome.mdx

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,15 @@ Welcome to the Plant Store API docs! This site demonstrates how to use Fern to g
1212
Here you'll find information about managing your plants, customers, and orders for your plant shop.
1313

1414
<CardGroup>
15-
<Card title="API Reference" icon="fa-solid fa-code" href="/api-reference" />
15+
<Card
16+
title="API Reference"
17+
icon="fa-solid fa-code"
18+
href="/api-reference"
19+
/>
1620
<Card
17-
title="Discord Community"
18-
icon="fa-brands fa-discord"
19-
href="https://discord.com/invite/JkkXumPzcG"
21+
title="Slack Community"
22+
icon="fa-brands fa-slack"
23+
href="https://join.slack.com/t/fern-community/shared_invite/zt-2q7ev4mki-mhO5anKslwRowp4oExWf4A"
2024
/>
2125
<Card
2226
title="Blog"

fern/fern.config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"organization": "plantstore",
3-
"version": "0.77.3"
3+
"version": "0.77.4"
44
}

0 commit comments

Comments
 (0)