Skip to content

Commit eb194fc

Browse files
Kapil GowruKapil Gowru
authored andcommitted
feat: added folders for fern definition and openapi definition
1 parent 7abffdc commit eb194fc

File tree

90 files changed

+4416
-139
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+4416
-139
lines changed

fern/assets/styles.css

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@
9292
grid-row: 2;
9393
}
9494

95-
> a[href*="api-definition"]:before {
95+
/* > a[href*="api-definition"]:before {
9696
content: "Utilities";
9797
font-weight: 500;
9898
position: absolute;
@@ -108,19 +108,7 @@
108108
width: 1.5rem;
109109
height: 1.5rem;
110110
}
111-
}
112-
113-
114-
> a[href*="cli-api-reference"] {
115-
grid-column: 3;
116-
grid-row: 2;
117-
transform: translateY(-32px);
118-
119-
.fern-selection-item-icon {
120-
width: 1.5rem;
121-
height: 1.5rem;
122-
}
123-
}
111+
} */
124112

125113
> a[href*="openapi"]:before {
126114
content: "Supported Specs";
@@ -151,6 +139,17 @@
151139
}
152140
}
153141

142+
> a[href*="cli-api-reference"] {
143+
grid-column: 3;
144+
grid-row: 3;
145+
transform: translateY(-64px);
146+
147+
.fern-selection-item-icon {
148+
width: 1.5rem;
149+
height: 1.5rem;
150+
}
151+
}
152+
154153
> a[href*="asyncapi"] {
155154
grid-column: 3;
156155
grid-row: 3;

fern/docs.yml

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -32,30 +32,31 @@ products:
3232
slug: ask-fern
3333
subtitle: Let users find answers in your documentation instantly
3434

35-
- display-name: API Definition
36-
path: ./products/api-definition/api-definition.yml
35+
36+
# - display-name: API Definition
37+
# path: ./products/api-definition/api-definition.yml
38+
# icon: fa-regular fa-book
39+
# image: ./images/product-switcher/api-definitions-light.png
40+
# slug: api-definition
41+
42+
- display-name: OpenAPI
43+
path: ./products/openapi-def/openapi-def.yml
3744
icon: fa-regular fa-book
38-
image: ./images/product-switcher/api-definitions-light.png
39-
slug: api-definition
45+
image: ./images/product-switcher/openapi-def.png
46+
slug: openapi
47+
48+
- display-name: Fern Definition
49+
path: ./products/fern-def/fern-def.yml
50+
icon: fa-regular fa-seedling
51+
image: ./images/product-switcher/fern-def.png
52+
slug: fern-def
4053

4154
- display-name: CLI & API Reference
4255
path: ./products/cli-api-reference/cli-api-reference.yml
4356
icon: fa-regular fa-terminal
4457
image: ./images/product-switcher/cli-api-reference-light.png
4558
slug: cli-api-reference
4659

47-
# - display-name: OpenAPI
48-
# path: ./products/openapi-def/openapi-def.yml
49-
# icon: fa-regular fa-book
50-
# image: ./images/product-switcher/openapi-def.png
51-
# slug: openapi
52-
53-
# - display-name: Fern Definition
54-
# path: ./products/fern-def/fern-def.yml
55-
# icon: fa-regular fa-seedling
56-
# image: ./images/product-switcher/fern-def.png
57-
# slug: fern-def
58-
5960
# - display-name: AsyncAPI
6061
# path: ./products/asyncapi-def/asyncapi-def.yml
6162
# icon: fa-regular fa-bolt
@@ -150,7 +151,7 @@ analytics:
150151
# Redirects for new docs structure migration
151152
redirects:
152153
- source: /learn/welcome
153-
destination: /learn/home
154+
destination: /learn
154155
permanent: true
155156
- source: /learn
156157
destination: /learn/home
@@ -205,10 +206,13 @@ redirects:
205206
- source: /learn/sdks/guides/publish-to-package-managers/packagist
206207
destination: /learn/sdks/generators/php/publishing-to-packagist
207208
permanent: true
208-
# PAUSED HERE
209209
- source: /learn/sdks/introduction/configuration
210210
destination: /learn/sdks/introduction/language-support
211211
permanent: true
212+
- source: /learn/sdks/introduction/language-support
213+
destination: /learn/sdks/overview/introduction
214+
permanent: true
215+
## PAUSED HERE
212216
- source: /learn/sdks/getting-started/:slug*
213217
destination: /learn/sdks/guides/:slug*
214218
permanent: true
Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,55 @@
11
navigation:
2-
- section: Getting Started
2+
- page: Overview
3+
path: ./pages/overview.mdx
4+
- page: Authentication
5+
path: ./pages/auth.mdx
6+
- page: Types
7+
path: ./pages/types.mdx
8+
- section: Endpoints
9+
path: ./pages/endpoints.mdx
10+
contents:
11+
- page: HTTP JSON Endpoints
12+
path: ./pages/endpoints/rest.mdx
13+
slug: http
14+
- page: Multipart Form Uploads
15+
path: ./pages/endpoints/multipart.mdx
16+
slug: multipart
17+
- page: Bytes
18+
path: ./pages/endpoints/bytes.mdx
19+
slug: bytes
20+
- page: Server-Sent Events
21+
path: ./pages/endpoints/sse.mdx
22+
slug: sse
23+
- page: Webhooks
24+
path: ./pages/webhooks.mdx
25+
- page: WebSockets
26+
path: ./pages/websockets.mdx
27+
slug: websockets
28+
- page: Errors
29+
path: ./pages/errors.mdx
30+
- page: Imports
31+
path: ./pages/imports.mdx
32+
- page: Examples
33+
path: ./pages/examples.mdx
34+
- page: Audiences
35+
path: ./pages/audiences.mdx
36+
- page: Availability
37+
path: ./pages/availability.mdx
38+
- section: api.yml Reference
39+
slug: api-yml
340
contents:
441
- page: Overview
5-
path: ./pages/getting-started/overview.mdx
6-
- page: Quickstart
7-
path: ./pages/getting-started/quickstart.mdx
8-
- page: Philosophy
9-
path: ./pages/getting-started/philosophy.mdx
10-
- page: Customer Showcase
11-
path: ./pages/getting-started/customer-showcase.mdx
12-
- section: Global Settings
13-
contents:
14-
- page: Authentication
15-
path: ./pages/global-settings/authentication.mdx
16-
- page: Global Headers
17-
path: ./pages/global-settings/global-headers.mdx
42+
path: ./pages/api-yml/overview.mdx
1843
- page: Environments
19-
path: ./pages/global-settings/environments.mdx
20-
- page: API Versions
21-
path: ./pages/global-settings/api-versions.mdx
22-
- section: Defining your API
23-
contents:
24-
- page: Types
25-
path: ./pages/defining-your-api/types.mdx
26-
- page: Imports
27-
path: ./pages/defining-your-api/imports.mdx
28-
- page: Endpoints
29-
path: ./pages/defining-your-api/endpoints.mdx
30-
- page: Webhooks
31-
path: ./pages/defining-your-api/webhooks.mdx
32-
- page: WebSockets
33-
path: ./pages/defining-your-api/websockets.mdx
34-
- page: Examples
35-
path: ./pages/defining-your-api/examples.mdx
44+
path: ./pages/api-yml/environments.mdx
45+
- page: Global Headers
46+
path: ./pages/api-yml/global-configuration.mdx
3647
- page: Errors
37-
path: ./pages/defining-your-api/errors.mdx
38-
- page: Doc
39-
path: ./pages/defining-your-api/doc.mdx
40-
- page: Availability
41-
path: ./pages/defining-your-api/availability.mdx
42-
- page: Audiences
43-
path: ./pages/defining-your-api/audiences.mdx
44-
- section: Guides
45-
contents:
46-
- page: Validate your Fern Definition
47-
path: ./pages/guides/validate-your-fern-definition.mdx
48-
- page: Define multiple APIs
49-
path: ./pages/guides/define-multiple-apis.mdx
50-
- page: Export to OpenAPI
51-
path: ./pages/guides/export-to-openapi.mdx
52-
- page: Depending on other APIs
53-
path: ./pages/guides/depending-on-other-apis.mdx
54-
- page: Creating namespaces
55-
path: ./pages/guides/creating-namespaces.mdx
48+
path: ./pages/api-yml/errors.mdx
49+
- page: Packages
50+
path: ./pages/packages.mdx
51+
- page: Depending on Other APIs
52+
path: ./pages/depending-on-other-apis.mdx
53+
- page: Export to OpenAPI
54+
slug: export-openapi
55+
path: ./pages/export-openapi.mdx
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)