From 6e986c28bef991a934ee0a581c44fb3f14fd8c43 Mon Sep 17 00:00:00 2001 From: Minae Lee Date: Sat, 2 Mar 2024 18:47:27 -0700 Subject: [PATCH 1/3] remove assets contents from folder index shown in readme as not relevant --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index d46d23a..5f48a86 100644 --- a/README.md +++ b/README.md @@ -44,10 +44,7 @@ The `fern/` folder in your repository contains these files and folders: ├─ store.yml └─ user.yml ├─ docs/ - ├─ assets/ - ├─ favicon.png - ├─ logo_dark_mode.png - └─ logo_light_mode.png + └─ assets/ └─ pages/ ├─ sdks.mdx └─ welcome.mdx From 3fa894d7b53a3feca50829ffa1a39809ce37e8e3 Mon Sep 17 00:00:00 2001 From: Minae Lee Date: Sat, 2 Mar 2024 19:04:40 -0700 Subject: [PATCH 2/3] fix fern page index in readme --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5f48a86..bfc341f 100644 --- a/README.md +++ b/README.md @@ -46,11 +46,11 @@ The `fern/` folder in your repository contains these files and folders: ├─ docs/ └─ assets/ └─ pages/ + ├─ concepts.mdx ├─ sdks.mdx └─ welcome.mdx - ├─ docs.yml -├─ fern.config.json -└─ generators.yml +├─ docs.yml +└─ fern.config.json ``` The `definition/` folder contains Fern Definition files for a sample API called Swagger Petstore. Fern uses these files to generate the API Reference section of your docs site. From b06227d6568fd1b0313b9d44d364846e805c5d29 Mon Sep 17 00:00:00 2001 From: Minae Lee Date: Sat, 2 Mar 2024 20:04:27 -0700 Subject: [PATCH 3/3] fix errors in readme --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bfc341f..1bc49e2 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ Here's [an example.](https://docs.propexo.com/documentation) - Node 18 or higher - A [GitHub](https://github.com) account +- Familiarity with using a CLI --- @@ -87,7 +88,6 @@ Install the Fern CLI tool globally by running: npm install -g fern-api ``` -When prompted, log into and connect your GitHub account. > [!NOTE] > The above CLI command is a global command that you can run from any location. The `fern` commands in the following steps must be run from within your repository. @@ -96,10 +96,12 @@ When prompted, log into and connect your GitHub account. Run the following command: -```bash +```shell fern generate --docs ``` +When prompted, log into and connect your GitHub account. + Once the documentation is generated, Fern displays the URL where you can view the published documentation. For example: ```shell @@ -134,11 +136,11 @@ To learn about Fern's built-in component library you can use in Markdown: ### Step 7: Set up a custom domain -If you wish to use a custom subdomain like `https://docs.YOUR_ORGANIZATION.com` or a subpath like `https://YOUR_ORGANIZATION.com/docs`, you can subscribe to the [Starter plan](https://buildwithfern.com/pricing). Once subscribed, update `docs.yml` with the custom domain configuration, replacing YOUR_ORGANIZATION with your own. +If you wish to use a custom subdomain like `https://docs.YOUR_ORGANIZATION.COM` or a subpath like `https://YOUR_ORGANIZATION.COM/docs`, you can subscribe to the [Starter plan](https://buildwithfern.com/pricing). Once subscribed, update `docs.yml` with the custom domain configuration, replacing YOUR_ORGANIZATION with your own: ```yaml - url: YOUR_ORGANIZATION.docs.buildwithfern.com - custom-domain: docs.YOUR_ORGANIZATION.com + custom-domain: docs.YOUR_ORGANIZATION.COM ``` Good luck creating beautiful and functional documentation! 🌿