From 8a54c46f1cdf45199268c289634fd0693f58273b Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Mon, 21 Jul 2025 14:06:33 -0400 Subject: [PATCH 1/2] start of hiding files --- fern/products/sdks/overview/dotnet/quickstart.mdx | 3 +-- fern/products/sdks/overview/go/quickstart.mdx | 3 +-- fern/products/sdks/overview/java/quickstart.mdx | 3 +-- fern/products/sdks/overview/php/quickstart.mdx | 3 +-- fern/products/sdks/overview/python/quickstart.mdx | 3 +-- fern/products/sdks/overview/ruby/quickstart.mdx | 3 +-- .../products/sdks/overview/typescript/quickstart.mdx | 12 ++++++------ fern/products/sdks/sdks.yml | 1 + .../sdks/snippets/initialize-fern-folder-intro.mdx | 2 ++ .../{option-3-fern-def.mdx => option-2-fern-def.mdx} | 0 .../{option-2-asyncapi.mdx => option-3-asyncapi.mdx} | 2 +- 11 files changed, 16 insertions(+), 19 deletions(-) create mode 100644 fern/products/sdks/snippets/initialize-fern-folder-intro.mdx rename fern/products/sdks/snippets/{option-3-fern-def.mdx => option-2-fern-def.mdx} (100%) rename fern/products/sdks/snippets/{option-2-asyncapi.mdx => option-3-asyncapi.mdx} (96%) diff --git a/fern/products/sdks/overview/dotnet/quickstart.mdx b/fern/products/sdks/overview/dotnet/quickstart.mdx index 623175438..e92a9d28c 100644 --- a/fern/products/sdks/overview/dotnet/quickstart.mdx +++ b/fern/products/sdks/overview/dotnet/quickstart.mdx @@ -12,8 +12,7 @@ Generate a C#/.NET SDK by following the instructions on this page. ### Initialize the Fern Folder - You can use either the OpenAPI definition, AsyncAPI definition, or Fern - Definition to generate your SDK. + diff --git a/fern/products/sdks/overview/go/quickstart.mdx b/fern/products/sdks/overview/go/quickstart.mdx index 9bc1ff170..710e2a79a 100644 --- a/fern/products/sdks/overview/go/quickstart.mdx +++ b/fern/products/sdks/overview/go/quickstart.mdx @@ -12,8 +12,7 @@ Generate a Go SDK by following the instructions on this page. ### Initialize the Fern Folder - You can use either the OpenAPI definition, AsyncAPI definition, or Fern - Definition to generate your SDK. + diff --git a/fern/products/sdks/overview/java/quickstart.mdx b/fern/products/sdks/overview/java/quickstart.mdx index 9c1f430b5..207b56f13 100644 --- a/fern/products/sdks/overview/java/quickstart.mdx +++ b/fern/products/sdks/overview/java/quickstart.mdx @@ -12,8 +12,7 @@ Generate a Java SDK by following the instructions on this page. ### Initialize the Fern Folder - You can use either the OpenAPI definition, AsyncAPI definition, or Fern - Definition to generate your SDK. + diff --git a/fern/products/sdks/overview/php/quickstart.mdx b/fern/products/sdks/overview/php/quickstart.mdx index fff4c8833..e58530c57 100644 --- a/fern/products/sdks/overview/php/quickstart.mdx +++ b/fern/products/sdks/overview/php/quickstart.mdx @@ -12,8 +12,7 @@ Generate a PHP SDK by following the instructions on this page. ### Initialize the Fern Folder - You can use either the OpenAPI definition, AsyncAPI definition, or Fern - Definition to generate your SDK. + diff --git a/fern/products/sdks/overview/python/quickstart.mdx b/fern/products/sdks/overview/python/quickstart.mdx index 00769436a..5c973c0a1 100644 --- a/fern/products/sdks/overview/python/quickstart.mdx +++ b/fern/products/sdks/overview/python/quickstart.mdx @@ -12,8 +12,7 @@ Generate a Python SDK by following the instructions on this page. ### Initialize the Fern Folder - You can use either the OpenAPI definition, AsyncAPI definition, or Fern - Definition to generate your SDK. + diff --git a/fern/products/sdks/overview/ruby/quickstart.mdx b/fern/products/sdks/overview/ruby/quickstart.mdx index 4bba86429..32eaefcc4 100644 --- a/fern/products/sdks/overview/ruby/quickstart.mdx +++ b/fern/products/sdks/overview/ruby/quickstart.mdx @@ -12,8 +12,7 @@ Generate a Ruby SDK by following the instructions on this page. ### Initialize the Fern Folder - You can use either the OpenAPI definition, AsyncAPI definition, or Fern - Definition to generate your SDK. + diff --git a/fern/products/sdks/overview/typescript/quickstart.mdx b/fern/products/sdks/overview/typescript/quickstart.mdx index e457a68c3..b0d12101d 100644 --- a/fern/products/sdks/overview/typescript/quickstart.mdx +++ b/fern/products/sdks/overview/typescript/quickstart.mdx @@ -12,16 +12,14 @@ Generate a TypeScript SDK by following the instructions on this page. ### Initialize the Fern Folder - You can use either the OpenAPI definition, AsyncAPI definition, or Fern Definition to generate your SDK. + - - - + - + 2. Add the config option `outputSourceFiles: true` to `generators.yml`. This ensures your SDK contains source files in @@ -49,10 +47,12 @@ Generate a TypeScript SDK by following the instructions on this page. local`. In subsequent steps, you'll add an additional generator for your preferred SDK language. + + {/* */} - + ### Add the SDK generator diff --git a/fern/products/sdks/sdks.yml b/fern/products/sdks/sdks.yml index e65db5a54..dba91b532 100644 --- a/fern/products/sdks/sdks.yml +++ b/fern/products/sdks/sdks.yml @@ -147,6 +147,7 @@ navigation: - page: Filter Your Endpoints (Audiences) path: ./guides/filter-your-endpoints-audiences.mdx - page: Self-host Fern's SDK Generators + hidden: true path: ./guides/self-host-fern-generators.mdx - section: Reference contents: diff --git a/fern/products/sdks/snippets/initialize-fern-folder-intro.mdx b/fern/products/sdks/snippets/initialize-fern-folder-intro.mdx new file mode 100644 index 000000000..bc5f0a331 --- /dev/null +++ b/fern/products/sdks/snippets/initialize-fern-folder-intro.mdx @@ -0,0 +1,2 @@ +You can use either the OpenAPI definition or Fern + Definition to generate your SDK. \ No newline at end of file diff --git a/fern/products/sdks/snippets/option-3-fern-def.mdx b/fern/products/sdks/snippets/option-2-fern-def.mdx similarity index 100% rename from fern/products/sdks/snippets/option-3-fern-def.mdx rename to fern/products/sdks/snippets/option-2-fern-def.mdx diff --git a/fern/products/sdks/snippets/option-2-asyncapi.mdx b/fern/products/sdks/snippets/option-3-asyncapi.mdx similarity index 96% rename from fern/products/sdks/snippets/option-2-asyncapi.mdx rename to fern/products/sdks/snippets/option-3-asyncapi.mdx index c4b5b0e04..b445e5004 100644 --- a/fern/products/sdks/snippets/option-2-asyncapi.mdx +++ b/fern/products/sdks/snippets/option-3-asyncapi.mdx @@ -1,4 +1,4 @@ - + Initialize the Fern folder using your AsyncAPI Specification. Run one of the following commands based on your spec's location. From cb4337ead29574e4050448ebea77b6fcb0f3f0dc Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Mon, 21 Jul 2025 15:56:38 -0400 Subject: [PATCH 2/2] update the rest of the quickstarts --- fern/products/sdks/overview/dotnet/quickstart.mdx | 8 ++++---- fern/products/sdks/overview/go/quickstart.mdx | 8 ++++---- fern/products/sdks/overview/java/quickstart.mdx | 8 ++++---- fern/products/sdks/overview/php/quickstart.mdx | 8 ++++---- fern/products/sdks/overview/python/quickstart.mdx | 8 ++++---- fern/products/sdks/overview/ruby/quickstart.mdx | 8 ++++---- 6 files changed, 24 insertions(+), 24 deletions(-) diff --git a/fern/products/sdks/overview/dotnet/quickstart.mdx b/fern/products/sdks/overview/dotnet/quickstart.mdx index e92a9d28c..ee54b08bc 100644 --- a/fern/products/sdks/overview/dotnet/quickstart.mdx +++ b/fern/products/sdks/overview/dotnet/quickstart.mdx @@ -16,12 +16,10 @@ Generate a C#/.NET SDK by following the instructions on this page. - - - + - + 2. Add the config option `outputSourceFiles: true` to `generators.yml`. This ensures your SDK contains source files in @@ -50,6 +48,8 @@ Generate a C#/.NET SDK by following the instructions on this page. preferred SDK language. + {/* */} + diff --git a/fern/products/sdks/overview/go/quickstart.mdx b/fern/products/sdks/overview/go/quickstart.mdx index 710e2a79a..88879ff41 100644 --- a/fern/products/sdks/overview/go/quickstart.mdx +++ b/fern/products/sdks/overview/go/quickstart.mdx @@ -16,12 +16,10 @@ Generate a Go SDK by following the instructions on this page. - - - + - + 2. Add the config option `outputSourceFiles: true` to `generators.yml`. This ensures your SDK contains source files in @@ -50,6 +48,8 @@ Generate a Go SDK by following the instructions on this page. preferred SDK language. + {/* */} + diff --git a/fern/products/sdks/overview/java/quickstart.mdx b/fern/products/sdks/overview/java/quickstart.mdx index 207b56f13..89b667b34 100644 --- a/fern/products/sdks/overview/java/quickstart.mdx +++ b/fern/products/sdks/overview/java/quickstart.mdx @@ -16,12 +16,10 @@ Generate a Java SDK by following the instructions on this page. - - - + - + 2. Add the config option `outputSourceFiles: true` to `generators.yml`. This ensures your SDK contains source files in @@ -50,6 +48,8 @@ Generate a Java SDK by following the instructions on this page. preferred SDK language. + {/* */} + diff --git a/fern/products/sdks/overview/php/quickstart.mdx b/fern/products/sdks/overview/php/quickstart.mdx index e58530c57..709748815 100644 --- a/fern/products/sdks/overview/php/quickstart.mdx +++ b/fern/products/sdks/overview/php/quickstart.mdx @@ -16,12 +16,10 @@ Generate a PHP SDK by following the instructions on this page. - - - + - + 2. Add the config option `outputSourceFiles: true` to `generators.yml`. This ensures your SDK contains source files in @@ -50,6 +48,8 @@ Generate a PHP SDK by following the instructions on this page. preferred SDK language. + {/* */} + diff --git a/fern/products/sdks/overview/python/quickstart.mdx b/fern/products/sdks/overview/python/quickstart.mdx index 5c973c0a1..9b5c2ddeb 100644 --- a/fern/products/sdks/overview/python/quickstart.mdx +++ b/fern/products/sdks/overview/python/quickstart.mdx @@ -16,12 +16,10 @@ Generate a Python SDK by following the instructions on this page. - - - + - + 2. Add the config option `outputSourceFiles: true` to `generators.yml`. This ensures your SDK contains source files in @@ -50,6 +48,8 @@ Generate a Python SDK by following the instructions on this page. preferred SDK language. + {/* */} + diff --git a/fern/products/sdks/overview/ruby/quickstart.mdx b/fern/products/sdks/overview/ruby/quickstart.mdx index 32eaefcc4..d188a7196 100644 --- a/fern/products/sdks/overview/ruby/quickstart.mdx +++ b/fern/products/sdks/overview/ruby/quickstart.mdx @@ -16,12 +16,10 @@ Generate a Ruby SDK by following the instructions on this page. - - - + - + 2. Add the config option `outputSourceFiles: true` to `generators.yml`. This ensures your SDK contains source files in @@ -50,6 +48,8 @@ Generate a Ruby SDK by following the instructions on this page. preferred SDK language. + {/* */} +