Skip to content

Commit 234d969

Browse files
chore: upgrade CLI version and implement a user's suggestions (#74)
1 parent 1f59caa commit 234d969

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
# Docs Starter
1010

11-
Create beautiful documentation in under 5 minutes using an OpenAPI specification.
11+
Create beautiful documentation in under 5 minutes using your OpenAPI specification.
1212

1313
</div>
1414

@@ -22,12 +22,17 @@ Get inspired by API documentation built with Fern: [Webflow](https://developers.
2222

2323
- Node 18 or higher
2424
- A [GitHub](https://github.com) account
25+
- Knowledge of the command line
2526

2627
### Step 1: Use this template
2728

2829
1. Click on the **Use this template** button (found at the top right of this page). You must be logged into GitHub.
2930
2. Choose the option to **create a new repository**. Name it `fern-docs`.
30-
3. Install the Fern CLI by running:
31+
3. Install the Fern Command Line Interface (CLI) by running:
32+
33+
```bash
34+
npm install -g fern-api
35+
```
3136

3237
### Step 2: Clone and open the repo in your preferred code editor
3338

@@ -44,7 +49,7 @@ Open the `fern.config.json` file and change the organization name:
4449

4550
```json
4651
{
47-
"organization": "your-organization-name",
52+
"organization": "your-company-name",
4853
"version": "0.77.4"
4954
}
5055
```
@@ -55,12 +60,13 @@ Run the following command to ensure you are using the latest version of Fern:
5560
fern upgrade
5661
```
5762

58-
**2. Update `docs.yml`:**
59-
Open the `docs.yml` file and update the URL:
63+
Replace `plantstore` with your own organization's name. Use only alphanumeric characters, hyphens, and underscores. Do not use spaces and leave the rest of the URL (`docs.buildwithfern.com`) unchanged.
64+
65+
It should now read:
6066

6167
```yml
6268
instances:
63-
- url: your-organization-name.docs.buildwithfern.com
69+
- url: your-company-name.docs.buildwithfern.com
6470
```
6571
6672
### Step 4: Generate your documentation
@@ -77,7 +83,7 @@ Once the documentation is generated, you will receive the URL where your documen
7783

7884
```shell
7985
┌─
80-
│ ✓ your-organization-name.docs.buildwithfern.com
86+
│ ✓ your-company-name.docs.buildwithfern.com
8187
└─
8288
```
8389

0 commit comments

Comments
 (0)