You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fern/products/api-def/grpc-pages/overview.mdx
+55-9Lines changed: 55 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -162,23 +162,69 @@ enum ChatMessageType {
162
162
<Info> Need help getting started with gRPC and Fern? Get live support [here](https://fern-community.slack.com/join/shared_invite/zt-2dpftfmif-MuAegl8AfP_PK8s2tx350Q%EF%BB%BF#/shared-invite/email) </Info>
163
163
164
164
165
-
Start by initializing your fern folder with a gRPC service
166
165
167
-
<CodeGroup>
168
-
```sh protobuf
169
-
fern init --proto ./path/to/service.proto
166
+
<Steps>
167
+
<Steptitle="Create your fern directory">
168
+
Create a `fern/` folder in your project root.
169
+
170
+
```
171
+
fern/
172
+
```
173
+
</Step>
174
+
<Steptitle="Add your gRPC service">
175
+
Add your gRPC files to the fern directory. You can place it in a subfolder called `proto` or directly in the fern directory.
176
+
177
+
```
178
+
fern/
179
+
└─ proto/
180
+
├─ user_service.proto
181
+
└─ common.proto
170
182
```
171
-
```sh directory
172
-
fern init --proto-directory ./path/to/proto/files
183
+
</Step>
184
+
<Steptitle="Create a `fern.config.json` file">
185
+
Add a `fern.config.json` file in your fern directory that lists your organization and the current version of the Fern CLI:
Copy file name to clipboardExpand all lines: fern/products/api-def/openrpc-pages/overview.mdx
+51-10Lines changed: 51 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -146,22 +146,63 @@ components:
146
146
147
147
<Info> Considering options to generate an OpenRPC spec? Get live support [here](https://fern-community.slack.com/join/shared_invite/zt-2dpftfmif-MuAegl8AfP_PK8s2tx350Q%EF%BB%BF#/shared-invite/email) </Info>
148
148
149
-
Start by initializing your fern folder with an OpenRPC spec
149
+
<Steps>
150
+
<Step title="Create your fern directory">
151
+
Create a `fern/` folder in your project root.
150
152
151
-
<CodeGroup>
152
-
```sh file
153
-
fern init --openrpc ./path/to/openrpc
154
153
```
155
-
```sh url
156
-
fern init --openrpc https://host/path/to/openrpc
154
+
fern/
155
+
```
156
+
</Step>
157
+
<Step title="Add your OpenRPC specification">
158
+
Add your OpenRPC spec to the fern directory. You can place it in a subfolder called `openrpc` or directly in the fern directory.
159
+
160
+
```
161
+
fern/
162
+
└─ openrpc/
163
+
└─ openrpc.yml
164
+
```
165
+
</Step>
166
+
<Step title="Create a `fern.config.json` file">
167
+
Add a `fern.config.json` file in your fern directory that lists your organization and the current version of the Fern CLI:
0 commit comments