Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dannysheridan committed Feb 12, 2024
1 parent aeb57ee commit b49a6ce
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,39 +8,40 @@

# Docs Starter

Create beautiful documentation in under 5 minutes using an OpenAPI/Swagger specification. Here's [an example!](https://petstore-openapi.docs.buildwithfern.com)

In this tutorial, you will learn how to create beautiful documentation in under 5 minutes using an OpenAPI/Swagger specification.
</div>

---

### Step 1: Use this template

1. Click on the "Use this template" button. You must be logged into GitHub.
2. Create a new repository. Name it anything you like; `docs` is a common naming choice.
2. Create a new repository. Name is something like `fern-docs`.

### Step 2: Clone and open in your preferred code editor

Clone your newly created repository and open it in your favorite integrated development environment (IDE) or code editor.
Clone your newly created repository and open it in your favorite code editor (e.g., VS Code).

The files and folders discussed in the following steps will be inside a `fern` folder in your repository.

### Step 3: Customize organization name

In the `fern.config.json` file, replace the placeholder organization name with your actual organization name. For example:

```json
```diff
{
"organization": "Petstore",
- "organization": "Petstore",
+ "organization": "MY_ORGANIZATION_NAME",
"version": "0.17.8"
}
```

In the `docs.yml` file, update the docs URL to match your organization's naming convention. For example:

```yml
```diff
instances:
- url: petstore-openapi.docs.buildwithfern.com
- - url: petstore-openapi.docs.buildwithfern.com
+ - url: MY_ORGANIZATION_NAME.docs.buildwithfern.com
```

### Step 4: Install the Fern CLI
Expand All @@ -51,7 +52,7 @@ Install the Fern CLI globally by running:
npm install -g fern-api
```

As this is a global command, you can run it from any location. The CLI commands in the following steps must be run from within your repository.
The CLI commands in the following steps must be run from within the root of your repository.

### Step 5: Check that your OpenAPI specification is valid

Expand All @@ -77,6 +78,12 @@ Once the documentation is generated, you will receive a URL where your documenta
┌─
│ ✓ petstore-openapi.docs.buildwithfern.com
└─

# OR

┌─
│ ✓ MY_ORGANIZTION_NAME.docs.buildwithfern.com
└─
```

### Step 7: (Optional) Add your own OpenAPI specification file
Expand Down

0 comments on commit b49a6ce

Please sign in to comment.