Skip to content

Commit b758e61

Browse files
committed
add link to overrides page from docs project structure page
1 parent e7b4172 commit b758e61

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

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

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,10 +111,14 @@ title: Fern's Documentation
111111
<AccordionGroup>
112112
<Accordion title="OpenAPI">
113113
The `openapi` folder contains the OpenAPI Specification file for your API Reference section. Fern will read either a YAML or JSON file from this folder to generate the API Reference documentation. If you don't have an API Reference section, you can skip this folder.
114+
115+
In addition to your specification file, you can optionally [add an overrides file](/api-definitions/overview/overrides) for additional customizations.
116+
114117
<CodeBlock title="fern/openapi">
115118
```bash
116119
openapi
117-
└─ openapi.yaml # OR openapi.json
120+
├─ openapi.yaml # OR openapi.json
121+
└─ overrides.yaml
118122
```
119123
</CodeBlock>
120124

@@ -123,12 +127,16 @@ title: Fern's Documentation
123127
</Accordion>
124128
<Accordion title="Fern Definition">
125129
The `definition` folder contains the Fern Definition YAML files used to generate the API Reference section. If you don't have an API Reference section, you can skip this folder.
130+
131+
In addition to your specification file, you can optionally [add an overrides file](/api-definitions/overview/overrides) for additional customizations.
132+
126133
<CodeBlock title="fern/definition">
127134
```bash
128135
definition
129136
├─ pets.yaml
130137
├─ owners.yaml
131138
├─ stores.yaml
139+
├─ overrides.yaml
132140
└─ api.yaml
133141
```
134142
</CodeBlock>
@@ -137,14 +145,18 @@ title: Fern's Documentation
137145

138146
</Accordion>
139147
<Accordion title="Multiple APIs">
140-
If you have multiple APIs, you can organize them into separate folders within the `apis` folder. Each API should have its own API definition. For example:
148+
If you have multiple APIs, you can organize them into separate folders within the `apis` folder. Each API should have its own API definition and [(optional) overrides file](/api-definitions/overview/overrides).
149+
150+
For example:
141151
<CodeBlock title="fern/apis">
142152
```bash
143153
apis
144154
├─ admin
145-
│ └─ openapi.json
155+
│ ├─ openapi.json
156+
│ └─ overrides.yaml
146157
├─ user
147-
│ └─ openapi.yaml
158+
│ ├─ openapi.yaml
159+
│ └─ overrides.yaml
148160
```
149161
</CodeBlock>
150162

0 commit comments

Comments
 (0)