Add files

Author: dannysheridan

README.md

@@ -8,13 +8,13 @@
 
 # Docs Starter
 
-Create beautiful documentation in under 5 minutes using an OpenAPI specification (formerly Swagger).
+Create beautiful documentation in under 5 minutes using an OpenAPI specification.
 
 </div>
 
 ## Customer Showcase
 
-Get inspired by API documentation built with Fern: [Hume](https://dev.hume.ai) | [Webflow](https://developers.webflow.com) | [Cartesia](https://docs.cartesia.ai) | [Cohere](https://docs.cohere.com) | [ElevenLabs](https://elevenlabs.io/docs)
+Get inspired by API documentation built with Fern: [Webflow](https://developers.webflow.com) | [Cartesia](https://docs.cartesia.ai) | [Cohere](https://docs.cohere.com) | [ElevenLabs](https://elevenlabs.io/docs)
 
 ---
 
@@ -27,46 +27,41 @@ Get inspired by API documentation built with Fern: [Hume](https://dev.hume.ai) |
 
 1. Click on the **Use this template** button (found at the top right of this page). You must be logged into GitHub.
 2. Choose the option to **create a new repository**. Name it `fern-docs`.
+3. Install the Fern CLI by running:
+
+```bash
+npm install -g fern-api
+```
 
 ### Step 2: Clone and open the repo in your preferred code editor
 
-Clone your newly created repository and open it in your favorite code editor (e.g., VS Code).
+Clone your newly created repository and open it in your favorite code editor (e.g., Cursor, VS Code).
 
 The files and folders discussed in the following steps will be inside the `fern/` folder in your repository.
 
 ### Step 3: Customize your organization name
 
-Open the `fern.config.json` file, which looks like this:
+You need to replace `"plantstore"` with your own organization name in two files:
+
+**1. Update `fern.config.json`:**
+Open the `fern.config.json` file and change the organization name:
 
 ```json
 {
-  "organization": "Plantstore",
-  "version": "0.17.8"
+  "organization": "your-organization-name",
+  "version": "0.77.3"
 }
 ```
 
-Replace `"Plantstore"` with your own organization name within the quotes. Spaces are permitted. Leave the `version` number unchanged.
-
-Open the `docs.yml` file and locate the `url`, which looks like this:
+**2. Update `docs.yml`:**
+Open the `docs.yml` file and update the URL:
 
 ```yml
 instances:
-  - url: plantstore.docs.buildwithfern.com
-```
-
-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.
-
-### Step 4: Install the Fern CLI
-
-Install the Fern CLI globally by running:
-
-```bash
-npm install -g fern-api
+  - url: your-organization-name.docs.buildwithfern.com
 ```
 
-The CLI commands in the following steps must be run from within the root folder of your repository.
-
-### Step 5: Generate your documentation
+### Step 4: Generate your documentation
 
 Run the following command:
 
@@ -80,21 +75,15 @@ Once the documentation is generated, you will receive the URL where your documen
 
 ```shell
 ┌─
-│ ✓  plantstore.docs.buildwithfern.com
-└─
-
-# OR
-
-┌─
-│ ✓  MY_ORGANIZATION_NAME.docs.buildwithfern.com
+│ ✓  your-organization-name.docs.buildwithfern.com
 └─
 ```
 
-### Step 6: Try local development
+### Step 5: Try local development
 
 Preview your documentation locally. Run ​`fern docs dev`​ to access your docs on your local server at port 3000, hot-reloading as you edit your markdown and OpenAPI files. [Learn more](https://buildwithfern.com/learn/docs/getting-started/development?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=step6) or [watch a 10-second demo](https://www.loom.com/share/0a4658bd78cb45d5a9519277852c7a24?sid=3ce69ad0-bfdb-4fa1-9abf-2f4366d084b9).
 
-### Step 7: Customize your documentation
+### Step 6: Customize your documentation
 
 You must run `fern generate --docs` after any modifications to re-generate and publish your documentation site.
 
@@ -117,7 +106,7 @@ To learn about Fern's built-in component library you can use within MDX files:
 
 - See the [Component Library](https://buildwithfern.com/learn/docs/content/components/overview?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=step7).
 
-### Step 8: Set up a custom domain
+### 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?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=step8). Once subscribed, update `docs.yml` with the custom domain configuration:
 
@@ -126,7 +115,7 @@ If you wish to use a custom subdomain like `https://docs.YOUR_ORGANIZATION.com`
   custom-domain: plantstore.dev
 ```
 
-### Step 9: Explore advanced features
+### Step 8: Explore advanced features
 
 For advanced documentation features and options, view the full [project structure](https://buildwithfern.com/learn/docs/getting-started/project-structure?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=step9).
 

fern/docs.yml

@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://schema.buildwithfern.dev/docs-yml.json
+
 instances:
   - url: plantstore.docs.buildwithfern.com # update this to {yourorg}.docs.buildwithfern.com
     # custom-domain: plantstore.dev # specify your custom domain when you are ready to go live

fern/docs/pages/welcome.mdx

@@ -21,7 +21,7 @@ Here you'll find information about managing your plants, customers, and orders f
   <Card
     title="Blog"
     icon="fa-solid fa-signal"
-    href="https://blog.buildwithfern.com"
+    href="https://buildwithfern.com/blog"
   />
   <Card
     title="SOC 2 Audited"

fern/fern.config.json

@@ -1,4 +1,4 @@
 {
   "organization": "plantstore",
-  "version": "0.56.29"
+  "version": "0.77.3"
 }