@@ -7,72 +7,74 @@ Fern combines your API specifications, static Markdown files (like how-to guides
77
88This process is built around two major workflows: ** editing** and ** deploying** your documentation.
99
10- < Accordion title = " System architecture " >
10+ TEST some content added
1111
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- ```
12+ <Accordion title = " System architecture" >
13+ This diagram shows the technical infrastructure that powers the documentation generation process.
14+
15+ ```
16+ flowchart TD
17+ %% Input sources at the top
18+ subgraph inputs ["Input Sources"]
19+ API["API Specs"]
20+ DOCS["Docs.yml"]
21+ MDX["MDX files"]
22+ MEDIA["Media content"]
23+ end
24+
25+ %% Generation process
26+ GENERATE[["fern generate<br/>--docs"]]
27+
28+ %% AWS VPC section
29+ subgraph vpc ["Fern AWS VPC"]
30+ direction LR
31+ MICROSERVICE["Fern Docs<br/>microservice"]
32+ DATABASE[("Database")]
33+ S3[("S3")]
34+ end
35+
36+ %% External services
37+ SERVICES["External Services<br/>(UpStash, Algolia, PostHog,<br/>TurboPuffer, AI Inference)"]
38+
39+ %% Vercel hosting
40+ subgraph vercel ["Vercel"]
41+ direction LR
42+ STATIC["Static site"]
43+ EXPLORER["API explorer"]
44+ EDGE["Vercel Edge<br/>(Middleware)"]
45+ end
46+
47+ %% External connections as hexagons
48+ CLOUDFLARE{{"Cloudflare (CORS)"}}
49+ WORKOS{{"WorkOS"}}
50+ CUSTOMER{{"Customer API"}}
51+
52+ USER(("User"))
53+
54+ %% Vertical flow connections
55+ API --> GENERATE
56+ DOCS --> GENERATE
57+ MDX --> GENERATE
58+ MEDIA --> GENERATE
59+
60+ GENERATE --> MICROSERVICE
61+ MICROSERVICE --> SERVICES
62+ SERVICES <--> STATIC
63+
64+ STATIC --> CLOUDFLARE
65+ EXPLORER <--> CLOUDFLARE
66+ EDGE <--> WORKOS
67+
68+ CLOUDFLARE --> CUSTOMER
69+ EDGE <--> USER
70+
71+ %% Internal connections
72+ MICROSERVICE -.-> DATABASE
73+ MICROSERVICE -.-> S3
74+ ```
7475</Accordion >
7576
77+
7678## Content workflows
7779
7880You can update your documentation in two ways:
@@ -111,29 +113,29 @@ The deployed documentation site integrates with external systems like Cloudflare
111113</Steps >
112114
113115<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- ```
116+ This diagram shows how content flows from editing to deployment.
117+
118+ ```
119+ flowchart TD
120+ FE[Fern Editor]
121+ U[User]
122+ DR[Docs Repo]
123+ CLI[Fern CLI]
124+ Decision{Make a PR or edit in Fern Editor?}
125+ Spec((API Spec Repo))
126+ GA[GitHub Actions]
127+
128+ U ==> Decision
129+ Decision == Make edit ==> FE
130+ Decision == Open and Merge PR ==> DR
131+
132+ FE <== Fetches state and opens PR ==> DR
133+ DR == ① Merged PR triggers deployment flow ==> GA
134+
135+ Spec <-. ② Fetches and merges API spec .-> GA
136+
137+ GA == ③ Triggers doc regeneration ==> CLI
138+ CLI == ④ Deploys updated docs ==> Server[Fern Docs Server]
139+ ```
139140</Accordion >
141+
0 commit comments