Skip to content

Commit a59ed82

Browse files
Kapil GowruKapil Gowru
authored andcommitted
Merge remote-tracking branch 'origin/main' into 07-23-homepage-4
2 parents 01577d5 + 0305b4d commit a59ed82

File tree

26 files changed

+301
-333
lines changed

26 files changed

+301
-333
lines changed

README.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -39,19 +39,3 @@ To run the documentation site locally:
3939

4040
The development server will automatically reload when you make changes to the documentation files.
4141

42-
## Open Issues
43-
44-
Below are links to slack conversations about what docs need to be included as part of the revamp.
45-
46-
- https://buildwithfern.slack.com/archives/C0811KJCBL4/p1749843216981529
47-
- https://buildwithfern.slack.com/archives/C05J55L8JES/p1749852300828139
48-
- https://buildwithfern.slack.com/archives/C07EQ2VEFU5/p1750085639878549
49-
- https://buildwithfern.slack.com/archives/C052DFWVCG6/p1750097991824229?thread_ts=1750093356.728189&cid=C052DFWVCG6
50-
- Add on-prem docs to enterprise https://buildwithfern.slack.com/archives/C069FN9958X/p1750085336657299
51-
- https://buildwithfern.slack.com/archives/C052DFWVCG6/p1750105603399839
52-
- https://buildwithfern.slack.com/archives/C06N8147J4W/p1750374966649439
53-
- https://buildwithfern.slack.com/archives/C08L9HGAZ2T/p1750429522110329?thread_ts=1750420489.267739&cid=C08L9HGAZ2T
54-
- https://buildwithfern.slack.com/archives/C06N8147J4W/p1750523650796109
55-
- https://buildwithfern.slack.com/archives/C06UVH9HKRC/p1750709442534809?thread_ts=1750703512.877769&cid=C06UVH9HKRCj
56-
- https://buildwithfern.slack.com/archives/C08T7EHDHMW/p1750793551604399?thread_ts=1750792603.757169&cid=C08T7EHDHMW
57-

fern/products/api-definition/pages/introduction/what-is-the-fern-folder.mdx

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
---
22
title: The Fern Folder
3-
description: Describes the Fern folder structure
3+
description: Describes the fern folder structure and its contents
44
---
55

6-
Configuring fern starts with the `fern` folder. The fern folder contains your API definitions,
7-
generators, and your CLI version.
6+
Configuring fern starts with the `fern` folder which contains your API definitions, generators, and your CLI version.
87

98
## Directory structure
109

11-
When you run `fern init`, your Fern folder will be initialized with the following files:
10+
When you run `fern init`, your fern folder will be initialized with the following files:
1211
```bash
1312
fern/
1413
├─ fern.config.json
@@ -35,7 +34,7 @@ the version of the Fern CLI that you are using.
3534
```json
3635
{
3736
"organization": "imdb",
38-
"version": "0.31.2"
37+
"version": "<Markdown src="/products/sdks/snippets/fern-config-json-version.mdx"/>"
3938
}
4039
```
4140

@@ -88,7 +87,7 @@ api:
8887
8988
## Multiple APIs
9089
91-
The Fern folder is capable of housing multiple API definitions. Instead of placing your API definition at the top-level, you can nest them within an `apis` folder. Be sure to include a `generators.yml` file within each API folder that specifies the location of the API definition.
90+
The fern folder is capable of housing multiple API definitions. Instead of placing your API definition at the top-level, you can nest them within an `apis` folder. Be sure to include a `generators.yml` file within each API folder that specifies the location of the API definition.
9291

9392
<Tabs>
9493
<Tab title="OpenAPI Definition">

fern/products/api-definition/pages/openapi/automation.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Sync your OpenAPI Specification
3-
subtitle: Pull your latest OpenAPI Specification into your Fern Folder automatically.
3+
subtitle: Pull your latest OpenAPI Specification into your fern folder automatically.
44
---
55

66
If you host your OpenAPI Specification at a publicly available URL, you can have Fern programmatically fetch the latest spec on a preconfigured cadence through the [sync-openapi GitHub Action](https://github.com/fern-api/sync-openapi). This ensures your committed OpenAPI spec stays up to date with your live API.
@@ -49,6 +49,6 @@ If you host your OpenAPI Specification at a publicly available URL, you can have
4949
Navigate to your repository's `Settings > Secrets and variables > Actions`. Select **New repository secret**, name it `OPENAPI_SYNC_TOKEN`, add your token, and click **Add secret**.
5050
</Step>
5151
</Steps>
52-
By default, this will create daily PRs with API spec updates to the repo containing your Fern folder. If you would like to adjust the frequency, learn more about GitHub's [schedule event](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#schedule).
52+
By default, this will create daily PRs with API spec updates to the repo containing your fern folder. If you would like to adjust the frequency, learn more about GitHub's [schedule event](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#schedule).
5353

5454
<Info> For detailed configuration options and other use cases, see the [sync-openapi GitHub Action README](https://github.com/fern-api/sync-openapi). </Info>

fern/products/api-definition/pages/openapi/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,9 @@ components:
104104
in: header
105105
```
106106
107-
## Setup your Fern folder
107+
## Setup your fern folder
108108
109-
Start by initializing your Fern folder with an OpenAPI spec
109+
Start by initializing your fern folder with an OpenAPI spec
110110
111111
<CodeGroup>
112112
```sh file
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
## 0.15.0-rc0
2-
**`(chore):`** - **Break**: The fern directory now has a top-level `apis` directory to handle apis and docs no longer live within an api definition
2+
**`(chore):`** - **Break**: The fern folder now has a top-level `apis` directory to handle apis and docs no longer live within an api definition
33

fern/products/cli-api-reference/cli-changelog/2023-11-20.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,18 @@
1111
**`(chore):`** **Full Changelog**: https://github.com/fern-api/fern/compare/0.15.2-rc0...0.15.2-rc1
1212

1313
## 0.15.2-rc0
14-
**`(chore):`** ## What's Changed
15-
* upgrade json5 to `2.2.2` by @dsinghvi in https://github.com/fern-api/fern/pull/2304
16-
* chore: remove wire verification by @dsinghvi in https://github.com/fern-api/fern/pull/2305
17-
* chore: upgrade yaml to 2.3.3 by @dsinghvi in https://github.com/fern-api/fern/pull/2306
18-
* fix: `fern generate --local` with `.fernignore` fails in Github Workflow by @dsinghvi in https://github.com/fern-api/fern/pull/2307
19-
20-
14+
**`(chore):`** ## What's Changed
15+
* upgrade json5 to `2.2.2` by @dsinghvi in https://github.com/fern-api/fern/pull/2304
16+
* chore: remove wire verification by @dsinghvi in https://github.com/fern-api/fern/pull/2305
17+
* chore: upgrade yaml to 2.3.3 by @dsinghvi in https://github.com/fern-api/fern/pull/2306
18+
* fix: `fern generate --local` with `.fernignore` fails in Github Workflow by @dsinghvi in https://github.com/fern-api/fern/pull/2307
19+
20+
2121
**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.1...0.15.2-rc0
2222

2323
## 0.15.1
24-
**`(chore):`** _It's been forever since we released a non release candidate!_
25-
26-
**Break**
27-
- The file structure of the Fern folder has now changed. If you have a single API, your definition can live directly at the top-level. If you have multiple, they will need to live in an apis folder. When you run `fern upgrade` the directory structure will automatically be updated.
24+
**`(chore):`** _It's been forever since we released a non release candidate!_
25+
26+
**Break**
27+
- The file structure of the fern folder has now changed. If you have a single API, your definition can live directly at the top-level. If you have multiple, they will need to live in an apis folder. When you run `fern upgrade` the directory structure will automatically be updated.
2828

fern/products/cli-api-reference/pages/api-get-started.mdx

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,6 @@ subtitle: 'Welcome to the Fern API reference.'
77

88
The Fern API allows you to manage SDKs and code snippets using Fern's public RESTful API.
99

10-
## Accessing the Fern API
11-
12-
Fern maintains official API clients for TypeScript and Python. We recommend using these clients, though the API supports any language or framework that sends HTTP requests. Let us know if you'd like an SDK in another language.
13-
14-
<CardGroup cols={2}>
15-
<Card
16-
title='TypeScript'
17-
icon={<img src="https://upload.wikimedia.org/wikipedia/commons/d/d9/Node.js_logo.svg" alt="Node.js logo"/>}
18-
href='https://github.com/fern-api/typescript-sdk'
19-
>
20-
API client
21-
</Card>
22-
23-
<Card
24-
title='Python'
25-
icon={<img src="https://upload.wikimedia.org/wikipedia/commons/c/c3/Python-logo-notext.svg" alt="Python logo"/>}
26-
href='https://github.com/fern-api/python-sdk'
27-
>
28-
API client
29-
</Card>
30-
</CardGroup>
31-
3210
## Authentication
3311

3412
Fern API requests require a bearer token for authentication. Use the CLI command [`fern token`](/learn/cli-api/cli-reference/commands#fern-token) to generate a bearer token. Tokens do not expire.

fern/products/docs/pages/customization/project-structure.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ The `fern.config.json` file specifies your organization name and the version of
160160
```json
161161
{
162162
"organization": "my-organization",
163-
"version": "0.55.1"
163+
"version": "<Markdown src="/products/sdks/snippets/fern-config-json-version.mdx"/>"
164164
}
165165
```
166166
</CodeBlock>

fern/products/docs/pages/getting-started/project-structure.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ The `fern.config.json` file specifies your organization name and the version of
160160
```json
161161
{
162162
"organization": "my-organization",
163-
"version": "0.55.1"
163+
"version": "<Markdown src="/products/sdks/snippets/fern-config-json-version.mdx"/>"
164164
}
165165
```
166166
</CodeBlock>

fern/products/docs/pages/navigation/announcement-banner.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ announcement:
1010
message: "🚀 New feature: Announcements are available! (<a href=\"https://buildwithfern.com/learn/docs/building-your-docs/announcements\" target=\"_blank\">Learn more</a>) 🚀"
1111
```
1212
13-
Markdown and HTML is supported in the announcement message. You can include links, images, and other formatting. [Custom css](/learn/docs/building-your-docs/custom-css-global-js#custom-css) can be used to customize the style of the announcement.
13+
Markdown and HTML is supported in the announcement message. You can include links, images, and other formatting. [Custom CSS](/learn/docs/building-your-docs/custom-css-global-js#custom-css) can be used to customize the style of the announcement.

0 commit comments

Comments
 (0)