Skip to content

Commit 9c6af20

Browse files
fern-api[bot]fern-api[bot]
authored
Fern Editor: Update
1 parent 4f6c947 commit 9c6af20

File tree

3 files changed

+208
-202
lines changed

3 files changed

+208
-202
lines changed

‎fern/products/docs/pages/getting-started/how-it-works.mdx‎

Lines changed: 90 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -8,77 +8,77 @@ Fern combines your API specifications, static Markdown files (like how-to guides
88
This process is built around two major workflows: **editing** and **deploying** your documentation.
99

1010
<Accordion title="System architecture">
11-
12-
This diagram shows the technical infrastructure that powers the documentation generation process.
13-
14-
```mermaid
15-
flowchart TD
16-
%% Input sources at the top
17-
subgraph inputs ["Input Sources"]
18-
API["API Specs"]
19-
DOCS["Docs.yml"]
20-
MDX["MDX files"]
21-
MEDIA["Media content"]
22-
end
23-
24-
%% Generation process
25-
GENERATE[["fern generate<br/>--docs"]]
26-
27-
%% AWS VPC section
28-
subgraph vpc ["Fern AWS VPC"]
29-
direction LR
30-
MICROSERVICE["Fern Docs<br/>microservice"]
31-
DATABASE[("Database")]
32-
S3[("S3")]
33-
end
34-
35-
%% External services
36-
SERVICES["External Services<br/>(UpStash, Algolia, PostHog,<br/>TurboPuffer, AI Inference)"]
37-
38-
%% Vercel hosting
39-
subgraph vercel ["Vercel"]
40-
direction LR
41-
STATIC["Static site"]
42-
EXPLORER["API explorer"]
43-
EDGE["Vercel Edge<br/>(Middleware)"]
44-
end
45-
46-
%% External connections as hexagons
47-
CLOUDFLARE{{"Cloudflare (CORS)"}}
48-
WORKOS{{"WorkOS"}}
49-
CUSTOMER{{"Customer API"}}
50-
51-
USER(("User"))
52-
53-
%% Vertical flow connections
54-
API --> GENERATE
55-
DOCS --> GENERATE
56-
MDX --> GENERATE
57-
MEDIA --> GENERATE
58-
59-
GENERATE --> MICROSERVICE
60-
MICROSERVICE --> SERVICES
61-
SERVICES <--> STATIC
62-
63-
STATIC --> CLOUDFLARE
64-
EXPLORER <--> CLOUDFLARE
65-
EDGE <--> WORKOS
66-
67-
CLOUDFLARE --> CUSTOMER
68-
EDGE <--> USER
69-
70-
%% Internal connections
71-
MICROSERVICE -.-> DATABASE
72-
MICROSERVICE -.-> S3
73-
```
11+
This diagram shows the technical infrastructure that powers the documentation generation process.
12+
13+
```mermaid
14+
flowchart TD
15+
%% Input sources at the top
16+
subgraph inputs ["Input Sources"]
17+
API["API Specs"]
18+
DOCS["Docs.yml"]
19+
MDX["MDX files"]
20+
MEDIA["Media content"]
21+
end
22+
23+
%% Generation process
24+
GENERATE[["fern generate<br/>--docs"]]
25+
26+
%% AWS VPC section
27+
subgraph vpc ["Fern AWS VPC"]
28+
direction LR
29+
MICROSERVICE["Fern Docs<br/>microservice"]
30+
DATABASE[("Database")]
31+
S3[("S3")]
32+
end
33+
34+
%% External services
35+
SERVICES["External Services<br/>(UpStash, Algolia, PostHog,<br/>TurboPuffer, AI Inference)"]
36+
37+
%% Vercel hosting
38+
subgraph vercel ["Vercel"]
39+
direction LR
40+
STATIC["Static site"]
41+
EXPLORER["API explorer"]
42+
EDGE["Vercel Edge<br/>(Middleware)"]
43+
end
44+
45+
%% External connections as hexagons
46+
CLOUDFLARE{{"Cloudflare (CORS)"}}
47+
WORKOS{{"WorkOS"}}
48+
CUSTOMER{{"Customer API"}}
49+
50+
USER(("User"))
51+
52+
%% Vertical flow connections
53+
API --> GENERATE
54+
DOCS --> GENERATE
55+
MDX --> GENERATE
56+
MEDIA --> GENERATE
57+
58+
GENERATE --> MICROSERVICE
59+
MICROSERVICE --> SERVICES
60+
SERVICES <--> STATIC
61+
62+
STATIC --> CLOUDFLARE
63+
EXPLORER <--> CLOUDFLARE
64+
EDGE <--> WORKOS
65+
66+
CLOUDFLARE --> CUSTOMER
67+
EDGE <--> USER
68+
69+
%% Internal connections
70+
MICROSERVICE -.-> DATABASE
71+
MICROSERVICE -.-> S3
72+
```
7473
</Accordion>
7574

75+
7676
## Content workflows
7777

7878
You can update your documentation in two ways:
7979

80-
- **Direct editing**: Open a pull request directly in the [GitHub repository that contains your docs](/learn/docs/getting-started/project-structure) (including your `docs.yml` configuration and Markdown files).
81-
- **Fern Editor**: Use the [Fern Editor](/learn/docs/writing-content/fern-editor) to modify your docs without touching code. The Fern GitHub App fetches the current state from your docs repository and passes it to the Fern Editor. When you submit changes, the Fern GitHub App automatically opens a pull request for review.
80+
- **Direct editing**: Open a pull request directly in the [GitHub repository that contains your docs](/learn/docs/getting-started/project-structure) (including your `docs.yml` configuration and Markdown files).
81+
- **Fern Editor**: Use the [Fern Editor](/learn/docs/writing-content/fern-editor) to modify your docs without touching code. The Fern GitHub App fetches the current state from your docs repository and passes it to the Fern Editor. When you submit changes, the Fern GitHub App automatically opens a pull request for review.
8282

8383
After the update goes through your review process, an approver can merge it.
8484

@@ -111,29 +111,29 @@ The deployed documentation site integrates with external systems like Cloudflare
111111
</Steps>
112112

113113
<Accordion title="Editing and deployment workflows">
114-
115-
This diagram shows how content flows from editing to deployment.
116-
117-
```mermaid
118-
flowchart TD
119-
FE[Fern Editor]
120-
U[User]
121-
DR[Docs Repo]
122-
CLI[Fern CLI]
123-
Decision{Make a PR or edit in Fern Editor?}
124-
Spec((API Spec Repo))
125-
GA[GitHub Actions]
126-
127-
U ==> Decision
128-
Decision == Make edit ==> FE
129-
Decision == Open and Merge PR ==> DR
130-
131-
FE <== Fetches state and opens PR ==> DR
132-
DR == ① Merged PR triggers deployment flow ==> GA
133-
134-
Spec <-. ② Fetches and merges API spec .-> GA
135-
136-
GA == ③ Triggers doc regeneration ==> CLI
137-
CLI == ④ Deploys updated docs ==> Server[Fern Docs Server]
138-
```
114+
This diagram shows how content flows from editing to deployment.
115+
116+
```mermaid
117+
flowchart TD
118+
FE[Fern Editor]
119+
U[User]
120+
DR[Docs Repo]
121+
CLI[Fern CLI]
122+
Decision{Make a PR or edit in Fern Editor?}
123+
Spec((API Spec Repo))
124+
GA[GitHub Actions]
125+
126+
U ==> Decision
127+
Decision == Make edit ==> FE
128+
Decision == Open and Merge PR ==> DR
129+
130+
FE <== Fetches state and opens PR ==> DR
131+
DR == ① Merged PR triggers deployment flow ==> GA
132+
133+
Spec <-. ② Fetches and merges API spec .-> GA
134+
135+
GA == ③ Triggers doc regeneration ==> CLI
136+
CLI == ④ Deploys updated docs ==> Server[Fern Docs Server]
137+
```
139138
</Accordion>
139+

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

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -166,11 +166,11 @@ title: Fern's Documentation
166166
</AccordionGroup>
167167

168168
<Note>
169-
If you're using Fern for both API Reference documentation and SDKs, you'll use both `docs.yml` (the Docs configuration file) and `generators.yml` ([the SDK configuration file](/sdks/overview/project-structure#generatorsyml)) to configure [how SDK code snippets appear](/docs/api-references/sdk-snippets) in your API reference documentation.
169+
If you're using Fern for both API Reference documentation and SDKs, you'll use both `docs.yml` (the Docs configuration file) and `generators.yml` ([the SDK configuration file](/sdks/overview/project-structure#generatorsyml)) to configure [how SDK code snippets appear](/docs/api-references/sdk-snippets) in your API reference documentation.
170170

171171
If you're only using Fern for API Reference docs, not SDKs, your `generators.yml` should simply link to your spec:
172172

173-
```yaml title="generators.yml"
173+
```yaml
174174
api:
175175
specs:
176176
- openapi: ../openapi/openapi.json
@@ -189,6 +189,4 @@ The `fern.config.json` file specifies your organization name and the version of
189189
"version": "<Markdown src="/snippets/version-number-cli.mdx"/>"
190190
}
191191
```
192-
</CodeBlock>
193-
194-
192+
</CodeBlock>

0 commit comments

Comments
 (0)