From 877692752751c474eaf7a8adc7536ef32474523d Mon Sep 17 00:00:00 2001 From: Deep Singhvi Date: Wed, 2 Jul 2025 14:33:36 -0400 Subject: [PATCH] feat(docs): improve ia for sdk docs --- .../guides/configure-auth-schemes.mdx | 0 .../guides/configure-auto-pagination.mdx | 0 .../guides/configure-github-publishing.mdx | 0 .../guides/configure-global-headers.mdx | 0 .../guides/configure-idempotency.mdx | 0 .../guides/customize-method-names.mdx | 0 .../filter-your-endpoints-audiences.mdx | 0 .../sdks/guides/self-host-fern-generators.mdx | 5 + .../guides/setup-local-sdk-previews.mdx | 0 .../{pages/overview.mdx => introduction.mdx} | 0 .../{pages => overview}/dotnet/changelog.mdx | 0 .../dotnet/configuration.mdx | 0 .../sdks/overview/dotnet/custom-code.mdx | 4 + .../dotnet/customer-showcase.mdx | 0 .../{pages => overview}/dotnet/design.mdx | 0 .../dotnet/publishing-to-npm.mdx | 0 .../{pages => overview}/dotnet/quickstart.mdx | 0 .../sdks/{pages => overview}/go/changelog.mdx | 0 .../{pages => overview}/go/configuration.mdx | 0 .../products/sdks/overview/go/custom-code.mdx | 4 + .../go/customer-showcase.mdx | 0 .../sdks/{pages => overview}/go/design.mdx | 0 .../{pages => overview}/go/philosophy.mdx | 0 .../go/publishing-to-npm.mdx | 0 .../{pages => overview}/go/quickstart.mdx | 0 .../{pages => overview}/java/changelog.mdx | 0 .../java/configuration.mdx | 0 .../sdks/overview/java/custom-code.mdx | 4 + .../java/customer-showcase.mdx | 0 .../sdks/{pages => overview}/java/design.mdx | 0 .../java/publishing-to-npm.mdx | 0 .../{pages => overview}/java/quickstart.mdx | 0 .../{pages => overview}/php/changelog.mdx | 0 .../{pages => overview}/php/configuration.mdx | 0 .../sdks/overview/php/custom-code.mdx | 4 + .../php/customer-showcase.mdx | 0 .../sdks/{pages => overview}/php/design.mdx | 0 .../php/publishing-to-npm.mdx | 0 .../{pages => overview}/php/quickstart.mdx | 0 .../{pages => overview}/python/changelog.mdx | 0 .../python/configuration.mdx | 0 .../sdks/overview/python/custom-code.mdx | 4 + .../python/customer-showcase.mdx | 0 .../{pages => overview}/python/design.mdx | 0 .../python/publishing-to-npm.mdx | 0 .../{pages => overview}/python/quickstart.mdx | 0 .../{pages => overview}/ruby/changelog.mdx | 0 .../ruby/configuration.mdx | 0 .../sdks/overview/ruby/custom-code.mdx | 4 + .../ruby/customer-showcase.mdx | 0 .../sdks/{pages => overview}/ruby/design.mdx | 0 .../ruby/publishing-to-npm.mdx | 0 .../{pages => overview}/ruby/quickstart.mdx | 0 .../typescript/changelog.mdx | 0 .../typescript/configuration.mdx | 0 .../sdks/overview/typescript/custom-code.mdx | 4 + .../typescript/customer-showcase.mdx | 0 .../{pages => overview}/typescript/design.mdx | 0 .../typescript/publishing-to-npm.mdx | 0 .../typescript/quickstart.mdx | 0 .../sdks/pages/enterprise/on-premise-sdks.mdx | 8 -- .../reference/generators-yml-reference.mdx | 6 + .../{pages => }/sdk-customer-showcase.mdx | 0 fern/products/sdks/sdks.yml | 130 ++++++++++-------- 64 files changed, 110 insertions(+), 67 deletions(-) rename fern/products/sdks/{pages => }/guides/configure-auth-schemes.mdx (100%) rename fern/products/sdks/{pages => }/guides/configure-auto-pagination.mdx (100%) rename fern/products/sdks/{pages => }/guides/configure-github-publishing.mdx (100%) rename fern/products/sdks/{pages => }/guides/configure-global-headers.mdx (100%) rename fern/products/sdks/{pages => }/guides/configure-idempotency.mdx (100%) rename fern/products/sdks/{pages => }/guides/customize-method-names.mdx (100%) rename fern/products/sdks/{pages => }/guides/filter-your-endpoints-audiences.mdx (100%) create mode 100644 fern/products/sdks/guides/self-host-fern-generators.mdx rename fern/products/sdks/{pages => }/guides/setup-local-sdk-previews.mdx (100%) rename fern/products/sdks/{pages/overview.mdx => introduction.mdx} (100%) rename fern/products/sdks/{pages => overview}/dotnet/changelog.mdx (100%) rename fern/products/sdks/{pages => overview}/dotnet/configuration.mdx (100%) create mode 100644 fern/products/sdks/overview/dotnet/custom-code.mdx rename fern/products/sdks/{pages => overview}/dotnet/customer-showcase.mdx (100%) rename fern/products/sdks/{pages => overview}/dotnet/design.mdx (100%) rename fern/products/sdks/{pages => overview}/dotnet/publishing-to-npm.mdx (100%) rename fern/products/sdks/{pages => overview}/dotnet/quickstart.mdx (100%) rename fern/products/sdks/{pages => overview}/go/changelog.mdx (100%) rename fern/products/sdks/{pages => overview}/go/configuration.mdx (100%) create mode 100644 fern/products/sdks/overview/go/custom-code.mdx rename fern/products/sdks/{pages => overview}/go/customer-showcase.mdx (100%) rename fern/products/sdks/{pages => overview}/go/design.mdx (100%) rename fern/products/sdks/{pages => overview}/go/philosophy.mdx (100%) rename fern/products/sdks/{pages => overview}/go/publishing-to-npm.mdx (100%) rename fern/products/sdks/{pages => overview}/go/quickstart.mdx (100%) rename fern/products/sdks/{pages => overview}/java/changelog.mdx (100%) rename fern/products/sdks/{pages => overview}/java/configuration.mdx (100%) create mode 100644 fern/products/sdks/overview/java/custom-code.mdx rename fern/products/sdks/{pages => overview}/java/customer-showcase.mdx (100%) rename fern/products/sdks/{pages => overview}/java/design.mdx (100%) rename fern/products/sdks/{pages => overview}/java/publishing-to-npm.mdx (100%) rename fern/products/sdks/{pages => overview}/java/quickstart.mdx (100%) rename fern/products/sdks/{pages => overview}/php/changelog.mdx (100%) rename fern/products/sdks/{pages => overview}/php/configuration.mdx (100%) create mode 100644 fern/products/sdks/overview/php/custom-code.mdx rename fern/products/sdks/{pages => overview}/php/customer-showcase.mdx (100%) rename fern/products/sdks/{pages => overview}/php/design.mdx (100%) rename fern/products/sdks/{pages => overview}/php/publishing-to-npm.mdx (100%) rename fern/products/sdks/{pages => overview}/php/quickstart.mdx (100%) rename fern/products/sdks/{pages => overview}/python/changelog.mdx (100%) rename fern/products/sdks/{pages => overview}/python/configuration.mdx (100%) create mode 100644 fern/products/sdks/overview/python/custom-code.mdx rename fern/products/sdks/{pages => overview}/python/customer-showcase.mdx (100%) rename fern/products/sdks/{pages => overview}/python/design.mdx (100%) rename fern/products/sdks/{pages => overview}/python/publishing-to-npm.mdx (100%) rename fern/products/sdks/{pages => overview}/python/quickstart.mdx (100%) rename fern/products/sdks/{pages => overview}/ruby/changelog.mdx (100%) rename fern/products/sdks/{pages => overview}/ruby/configuration.mdx (100%) create mode 100644 fern/products/sdks/overview/ruby/custom-code.mdx rename fern/products/sdks/{pages => overview}/ruby/customer-showcase.mdx (100%) rename fern/products/sdks/{pages => overview}/ruby/design.mdx (100%) rename fern/products/sdks/{pages => overview}/ruby/publishing-to-npm.mdx (100%) rename fern/products/sdks/{pages => overview}/ruby/quickstart.mdx (100%) rename fern/products/sdks/{pages => overview}/typescript/changelog.mdx (100%) rename fern/products/sdks/{pages => overview}/typescript/configuration.mdx (100%) create mode 100644 fern/products/sdks/overview/typescript/custom-code.mdx rename fern/products/sdks/{pages => overview}/typescript/customer-showcase.mdx (100%) rename fern/products/sdks/{pages => overview}/typescript/design.mdx (100%) rename fern/products/sdks/{pages => overview}/typescript/publishing-to-npm.mdx (100%) rename fern/products/sdks/{pages => overview}/typescript/quickstart.mdx (100%) delete mode 100644 fern/products/sdks/pages/enterprise/on-premise-sdks.mdx create mode 100644 fern/products/sdks/reference/generators-yml-reference.mdx rename fern/products/sdks/{pages => }/sdk-customer-showcase.mdx (100%) diff --git a/fern/products/sdks/pages/guides/configure-auth-schemes.mdx b/fern/products/sdks/guides/configure-auth-schemes.mdx similarity index 100% rename from fern/products/sdks/pages/guides/configure-auth-schemes.mdx rename to fern/products/sdks/guides/configure-auth-schemes.mdx diff --git a/fern/products/sdks/pages/guides/configure-auto-pagination.mdx b/fern/products/sdks/guides/configure-auto-pagination.mdx similarity index 100% rename from fern/products/sdks/pages/guides/configure-auto-pagination.mdx rename to fern/products/sdks/guides/configure-auto-pagination.mdx diff --git a/fern/products/sdks/pages/guides/configure-github-publishing.mdx b/fern/products/sdks/guides/configure-github-publishing.mdx similarity index 100% rename from fern/products/sdks/pages/guides/configure-github-publishing.mdx rename to fern/products/sdks/guides/configure-github-publishing.mdx diff --git a/fern/products/sdks/pages/guides/configure-global-headers.mdx b/fern/products/sdks/guides/configure-global-headers.mdx similarity index 100% rename from fern/products/sdks/pages/guides/configure-global-headers.mdx rename to fern/products/sdks/guides/configure-global-headers.mdx diff --git a/fern/products/sdks/pages/guides/configure-idempotency.mdx b/fern/products/sdks/guides/configure-idempotency.mdx similarity index 100% rename from fern/products/sdks/pages/guides/configure-idempotency.mdx rename to fern/products/sdks/guides/configure-idempotency.mdx diff --git a/fern/products/sdks/pages/guides/customize-method-names.mdx b/fern/products/sdks/guides/customize-method-names.mdx similarity index 100% rename from fern/products/sdks/pages/guides/customize-method-names.mdx rename to fern/products/sdks/guides/customize-method-names.mdx diff --git a/fern/products/sdks/pages/guides/filter-your-endpoints-audiences.mdx b/fern/products/sdks/guides/filter-your-endpoints-audiences.mdx similarity index 100% rename from fern/products/sdks/pages/guides/filter-your-endpoints-audiences.mdx rename to fern/products/sdks/guides/filter-your-endpoints-audiences.mdx diff --git a/fern/products/sdks/guides/self-host-fern-generators.mdx b/fern/products/sdks/guides/self-host-fern-generators.mdx new file mode 100644 index 000000000..248671b58 --- /dev/null +++ b/fern/products/sdks/guides/self-host-fern-generators.mdx @@ -0,0 +1,5 @@ +--- +title: Self host Fern's SDK generators +--- + +Learn how to preview your SDKs locally before publishing them. \ No newline at end of file diff --git a/fern/products/sdks/pages/guides/setup-local-sdk-previews.mdx b/fern/products/sdks/guides/setup-local-sdk-previews.mdx similarity index 100% rename from fern/products/sdks/pages/guides/setup-local-sdk-previews.mdx rename to fern/products/sdks/guides/setup-local-sdk-previews.mdx diff --git a/fern/products/sdks/pages/overview.mdx b/fern/products/sdks/introduction.mdx similarity index 100% rename from fern/products/sdks/pages/overview.mdx rename to fern/products/sdks/introduction.mdx diff --git a/fern/products/sdks/pages/dotnet/changelog.mdx b/fern/products/sdks/overview/dotnet/changelog.mdx similarity index 100% rename from fern/products/sdks/pages/dotnet/changelog.mdx rename to fern/products/sdks/overview/dotnet/changelog.mdx diff --git a/fern/products/sdks/pages/dotnet/configuration.mdx b/fern/products/sdks/overview/dotnet/configuration.mdx similarity index 100% rename from fern/products/sdks/pages/dotnet/configuration.mdx rename to fern/products/sdks/overview/dotnet/configuration.mdx diff --git a/fern/products/sdks/overview/dotnet/custom-code.mdx b/fern/products/sdks/overview/dotnet/custom-code.mdx new file mode 100644 index 000000000..b0a33d915 --- /dev/null +++ b/fern/products/sdks/overview/dotnet/custom-code.mdx @@ -0,0 +1,4 @@ +--- +title: Adding custom code +description: Augment your TypeScript SDK with custom utilities +--- diff --git a/fern/products/sdks/pages/dotnet/customer-showcase.mdx b/fern/products/sdks/overview/dotnet/customer-showcase.mdx similarity index 100% rename from fern/products/sdks/pages/dotnet/customer-showcase.mdx rename to fern/products/sdks/overview/dotnet/customer-showcase.mdx diff --git a/fern/products/sdks/pages/dotnet/design.mdx b/fern/products/sdks/overview/dotnet/design.mdx similarity index 100% rename from fern/products/sdks/pages/dotnet/design.mdx rename to fern/products/sdks/overview/dotnet/design.mdx diff --git a/fern/products/sdks/pages/dotnet/publishing-to-npm.mdx b/fern/products/sdks/overview/dotnet/publishing-to-npm.mdx similarity index 100% rename from fern/products/sdks/pages/dotnet/publishing-to-npm.mdx rename to fern/products/sdks/overview/dotnet/publishing-to-npm.mdx diff --git a/fern/products/sdks/pages/dotnet/quickstart.mdx b/fern/products/sdks/overview/dotnet/quickstart.mdx similarity index 100% rename from fern/products/sdks/pages/dotnet/quickstart.mdx rename to fern/products/sdks/overview/dotnet/quickstart.mdx diff --git a/fern/products/sdks/pages/go/changelog.mdx b/fern/products/sdks/overview/go/changelog.mdx similarity index 100% rename from fern/products/sdks/pages/go/changelog.mdx rename to fern/products/sdks/overview/go/changelog.mdx diff --git a/fern/products/sdks/pages/go/configuration.mdx b/fern/products/sdks/overview/go/configuration.mdx similarity index 100% rename from fern/products/sdks/pages/go/configuration.mdx rename to fern/products/sdks/overview/go/configuration.mdx diff --git a/fern/products/sdks/overview/go/custom-code.mdx b/fern/products/sdks/overview/go/custom-code.mdx new file mode 100644 index 000000000..b0a33d915 --- /dev/null +++ b/fern/products/sdks/overview/go/custom-code.mdx @@ -0,0 +1,4 @@ +--- +title: Adding custom code +description: Augment your TypeScript SDK with custom utilities +--- diff --git a/fern/products/sdks/pages/go/customer-showcase.mdx b/fern/products/sdks/overview/go/customer-showcase.mdx similarity index 100% rename from fern/products/sdks/pages/go/customer-showcase.mdx rename to fern/products/sdks/overview/go/customer-showcase.mdx diff --git a/fern/products/sdks/pages/go/design.mdx b/fern/products/sdks/overview/go/design.mdx similarity index 100% rename from fern/products/sdks/pages/go/design.mdx rename to fern/products/sdks/overview/go/design.mdx diff --git a/fern/products/sdks/pages/go/philosophy.mdx b/fern/products/sdks/overview/go/philosophy.mdx similarity index 100% rename from fern/products/sdks/pages/go/philosophy.mdx rename to fern/products/sdks/overview/go/philosophy.mdx diff --git a/fern/products/sdks/pages/go/publishing-to-npm.mdx b/fern/products/sdks/overview/go/publishing-to-npm.mdx similarity index 100% rename from fern/products/sdks/pages/go/publishing-to-npm.mdx rename to fern/products/sdks/overview/go/publishing-to-npm.mdx diff --git a/fern/products/sdks/pages/go/quickstart.mdx b/fern/products/sdks/overview/go/quickstart.mdx similarity index 100% rename from fern/products/sdks/pages/go/quickstart.mdx rename to fern/products/sdks/overview/go/quickstart.mdx diff --git a/fern/products/sdks/pages/java/changelog.mdx b/fern/products/sdks/overview/java/changelog.mdx similarity index 100% rename from fern/products/sdks/pages/java/changelog.mdx rename to fern/products/sdks/overview/java/changelog.mdx diff --git a/fern/products/sdks/pages/java/configuration.mdx b/fern/products/sdks/overview/java/configuration.mdx similarity index 100% rename from fern/products/sdks/pages/java/configuration.mdx rename to fern/products/sdks/overview/java/configuration.mdx diff --git a/fern/products/sdks/overview/java/custom-code.mdx b/fern/products/sdks/overview/java/custom-code.mdx new file mode 100644 index 000000000..b0a33d915 --- /dev/null +++ b/fern/products/sdks/overview/java/custom-code.mdx @@ -0,0 +1,4 @@ +--- +title: Adding custom code +description: Augment your TypeScript SDK with custom utilities +--- diff --git a/fern/products/sdks/pages/java/customer-showcase.mdx b/fern/products/sdks/overview/java/customer-showcase.mdx similarity index 100% rename from fern/products/sdks/pages/java/customer-showcase.mdx rename to fern/products/sdks/overview/java/customer-showcase.mdx diff --git a/fern/products/sdks/pages/java/design.mdx b/fern/products/sdks/overview/java/design.mdx similarity index 100% rename from fern/products/sdks/pages/java/design.mdx rename to fern/products/sdks/overview/java/design.mdx diff --git a/fern/products/sdks/pages/java/publishing-to-npm.mdx b/fern/products/sdks/overview/java/publishing-to-npm.mdx similarity index 100% rename from fern/products/sdks/pages/java/publishing-to-npm.mdx rename to fern/products/sdks/overview/java/publishing-to-npm.mdx diff --git a/fern/products/sdks/pages/java/quickstart.mdx b/fern/products/sdks/overview/java/quickstart.mdx similarity index 100% rename from fern/products/sdks/pages/java/quickstart.mdx rename to fern/products/sdks/overview/java/quickstart.mdx diff --git a/fern/products/sdks/pages/php/changelog.mdx b/fern/products/sdks/overview/php/changelog.mdx similarity index 100% rename from fern/products/sdks/pages/php/changelog.mdx rename to fern/products/sdks/overview/php/changelog.mdx diff --git a/fern/products/sdks/pages/php/configuration.mdx b/fern/products/sdks/overview/php/configuration.mdx similarity index 100% rename from fern/products/sdks/pages/php/configuration.mdx rename to fern/products/sdks/overview/php/configuration.mdx diff --git a/fern/products/sdks/overview/php/custom-code.mdx b/fern/products/sdks/overview/php/custom-code.mdx new file mode 100644 index 000000000..b0a33d915 --- /dev/null +++ b/fern/products/sdks/overview/php/custom-code.mdx @@ -0,0 +1,4 @@ +--- +title: Adding custom code +description: Augment your TypeScript SDK with custom utilities +--- diff --git a/fern/products/sdks/pages/php/customer-showcase.mdx b/fern/products/sdks/overview/php/customer-showcase.mdx similarity index 100% rename from fern/products/sdks/pages/php/customer-showcase.mdx rename to fern/products/sdks/overview/php/customer-showcase.mdx diff --git a/fern/products/sdks/pages/php/design.mdx b/fern/products/sdks/overview/php/design.mdx similarity index 100% rename from fern/products/sdks/pages/php/design.mdx rename to fern/products/sdks/overview/php/design.mdx diff --git a/fern/products/sdks/pages/php/publishing-to-npm.mdx b/fern/products/sdks/overview/php/publishing-to-npm.mdx similarity index 100% rename from fern/products/sdks/pages/php/publishing-to-npm.mdx rename to fern/products/sdks/overview/php/publishing-to-npm.mdx diff --git a/fern/products/sdks/pages/php/quickstart.mdx b/fern/products/sdks/overview/php/quickstart.mdx similarity index 100% rename from fern/products/sdks/pages/php/quickstart.mdx rename to fern/products/sdks/overview/php/quickstart.mdx diff --git a/fern/products/sdks/pages/python/changelog.mdx b/fern/products/sdks/overview/python/changelog.mdx similarity index 100% rename from fern/products/sdks/pages/python/changelog.mdx rename to fern/products/sdks/overview/python/changelog.mdx diff --git a/fern/products/sdks/pages/python/configuration.mdx b/fern/products/sdks/overview/python/configuration.mdx similarity index 100% rename from fern/products/sdks/pages/python/configuration.mdx rename to fern/products/sdks/overview/python/configuration.mdx diff --git a/fern/products/sdks/overview/python/custom-code.mdx b/fern/products/sdks/overview/python/custom-code.mdx new file mode 100644 index 000000000..b0a33d915 --- /dev/null +++ b/fern/products/sdks/overview/python/custom-code.mdx @@ -0,0 +1,4 @@ +--- +title: Adding custom code +description: Augment your TypeScript SDK with custom utilities +--- diff --git a/fern/products/sdks/pages/python/customer-showcase.mdx b/fern/products/sdks/overview/python/customer-showcase.mdx similarity index 100% rename from fern/products/sdks/pages/python/customer-showcase.mdx rename to fern/products/sdks/overview/python/customer-showcase.mdx diff --git a/fern/products/sdks/pages/python/design.mdx b/fern/products/sdks/overview/python/design.mdx similarity index 100% rename from fern/products/sdks/pages/python/design.mdx rename to fern/products/sdks/overview/python/design.mdx diff --git a/fern/products/sdks/pages/python/publishing-to-npm.mdx b/fern/products/sdks/overview/python/publishing-to-npm.mdx similarity index 100% rename from fern/products/sdks/pages/python/publishing-to-npm.mdx rename to fern/products/sdks/overview/python/publishing-to-npm.mdx diff --git a/fern/products/sdks/pages/python/quickstart.mdx b/fern/products/sdks/overview/python/quickstart.mdx similarity index 100% rename from fern/products/sdks/pages/python/quickstart.mdx rename to fern/products/sdks/overview/python/quickstart.mdx diff --git a/fern/products/sdks/pages/ruby/changelog.mdx b/fern/products/sdks/overview/ruby/changelog.mdx similarity index 100% rename from fern/products/sdks/pages/ruby/changelog.mdx rename to fern/products/sdks/overview/ruby/changelog.mdx diff --git a/fern/products/sdks/pages/ruby/configuration.mdx b/fern/products/sdks/overview/ruby/configuration.mdx similarity index 100% rename from fern/products/sdks/pages/ruby/configuration.mdx rename to fern/products/sdks/overview/ruby/configuration.mdx diff --git a/fern/products/sdks/overview/ruby/custom-code.mdx b/fern/products/sdks/overview/ruby/custom-code.mdx new file mode 100644 index 000000000..b0a33d915 --- /dev/null +++ b/fern/products/sdks/overview/ruby/custom-code.mdx @@ -0,0 +1,4 @@ +--- +title: Adding custom code +description: Augment your TypeScript SDK with custom utilities +--- diff --git a/fern/products/sdks/pages/ruby/customer-showcase.mdx b/fern/products/sdks/overview/ruby/customer-showcase.mdx similarity index 100% rename from fern/products/sdks/pages/ruby/customer-showcase.mdx rename to fern/products/sdks/overview/ruby/customer-showcase.mdx diff --git a/fern/products/sdks/pages/ruby/design.mdx b/fern/products/sdks/overview/ruby/design.mdx similarity index 100% rename from fern/products/sdks/pages/ruby/design.mdx rename to fern/products/sdks/overview/ruby/design.mdx diff --git a/fern/products/sdks/pages/ruby/publishing-to-npm.mdx b/fern/products/sdks/overview/ruby/publishing-to-npm.mdx similarity index 100% rename from fern/products/sdks/pages/ruby/publishing-to-npm.mdx rename to fern/products/sdks/overview/ruby/publishing-to-npm.mdx diff --git a/fern/products/sdks/pages/ruby/quickstart.mdx b/fern/products/sdks/overview/ruby/quickstart.mdx similarity index 100% rename from fern/products/sdks/pages/ruby/quickstart.mdx rename to fern/products/sdks/overview/ruby/quickstart.mdx diff --git a/fern/products/sdks/pages/typescript/changelog.mdx b/fern/products/sdks/overview/typescript/changelog.mdx similarity index 100% rename from fern/products/sdks/pages/typescript/changelog.mdx rename to fern/products/sdks/overview/typescript/changelog.mdx diff --git a/fern/products/sdks/pages/typescript/configuration.mdx b/fern/products/sdks/overview/typescript/configuration.mdx similarity index 100% rename from fern/products/sdks/pages/typescript/configuration.mdx rename to fern/products/sdks/overview/typescript/configuration.mdx diff --git a/fern/products/sdks/overview/typescript/custom-code.mdx b/fern/products/sdks/overview/typescript/custom-code.mdx new file mode 100644 index 000000000..b0a33d915 --- /dev/null +++ b/fern/products/sdks/overview/typescript/custom-code.mdx @@ -0,0 +1,4 @@ +--- +title: Adding custom code +description: Augment your TypeScript SDK with custom utilities +--- diff --git a/fern/products/sdks/pages/typescript/customer-showcase.mdx b/fern/products/sdks/overview/typescript/customer-showcase.mdx similarity index 100% rename from fern/products/sdks/pages/typescript/customer-showcase.mdx rename to fern/products/sdks/overview/typescript/customer-showcase.mdx diff --git a/fern/products/sdks/pages/typescript/design.mdx b/fern/products/sdks/overview/typescript/design.mdx similarity index 100% rename from fern/products/sdks/pages/typescript/design.mdx rename to fern/products/sdks/overview/typescript/design.mdx diff --git a/fern/products/sdks/pages/typescript/publishing-to-npm.mdx b/fern/products/sdks/overview/typescript/publishing-to-npm.mdx similarity index 100% rename from fern/products/sdks/pages/typescript/publishing-to-npm.mdx rename to fern/products/sdks/overview/typescript/publishing-to-npm.mdx diff --git a/fern/products/sdks/pages/typescript/quickstart.mdx b/fern/products/sdks/overview/typescript/quickstart.mdx similarity index 100% rename from fern/products/sdks/pages/typescript/quickstart.mdx rename to fern/products/sdks/overview/typescript/quickstart.mdx diff --git a/fern/products/sdks/pages/enterprise/on-premise-sdks.mdx b/fern/products/sdks/pages/enterprise/on-premise-sdks.mdx deleted file mode 100644 index ad9dbcd15..000000000 --- a/fern/products/sdks/pages/enterprise/on-premise-sdks.mdx +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: On-Premise SDKs -description: Learn how to use Fern SDKs in an on-premise environment. ---- - -# On-Premise SDKs - -Fern provides enterprise customers with the ability to generate and host SDKs in their own environment. This allows you to maintain full control over your SDK distribution while still leveraging Fern's powerful SDK generation capabilities. \ No newline at end of file diff --git a/fern/products/sdks/reference/generators-yml-reference.mdx b/fern/products/sdks/reference/generators-yml-reference.mdx new file mode 100644 index 000000000..e84acf187 --- /dev/null +++ b/fern/products/sdks/reference/generators-yml-reference.mdx @@ -0,0 +1,6 @@ +--- +title: generators.yml +description: Reference for the generators.yml configuration +--- + +Stay up to date with the latest changes and updates to the Fern Typescript SDK. diff --git a/fern/products/sdks/pages/sdk-customer-showcase.mdx b/fern/products/sdks/sdk-customer-showcase.mdx similarity index 100% rename from fern/products/sdks/pages/sdk-customer-showcase.mdx rename to fern/products/sdks/sdk-customer-showcase.mdx diff --git a/fern/products/sdks/sdks.yml b/fern/products/sdks/sdks.yml index b970f36ef..34db460cc 100644 --- a/fern/products/sdks/sdks.yml +++ b/fern/products/sdks/sdks.yml @@ -1,127 +1,139 @@ navigation: - - section: Fern SDKS + - section: Overview contents: - - page: Overview - path: ./pages/overview.mdx + - page: Introduction + path: ./introduction.mdx - link: Customer Showcase href: https://buildwithfern.com/showcase - section: Typescript contents: - page: Quickstart - path: ./pages/typescript/quickstart.mdx + path: ./overview/typescript/quickstart.mdx - page: Design Decisions - path: ./pages/typescript/design.mdx + path: ./overview/typescript/design.mdx - page: Configuration - path: ./pages/typescript/configuration.mdx + path: ./overview/typescript/configuration.mdx - page: Changelog - path: ./pages/typescript/changelog.mdx + path: ./overview/typescript/changelog.mdx - page: Publishing to NPM - path: ./pages/typescript/publishing-to-npm.mdx + path: ./overview/typescript/publishing-to-npm.mdx + - page: Adding custom code + path: ./overview/typescript/custom-code.mdx - link: Customer Showcase href: https://buildwithfern.com/showcase - section: Python contents: - page: Quickstart - path: ./pages/python/quickstart.mdx + path: ./overview/python/quickstart.mdx - page: Design Decisions - path: ./pages/python/design.mdx + path: ./overview/python/design.mdx - page: Configuration - path: ./pages/python/configuration.mdx + path: ./overview/python/configuration.mdx - page: Changelog - path: ./pages/python/changelog.mdx - - page: Publishing to NPM - path: ./pages/python/publishing-to-npm.mdx + path: ./overview/python/changelog.mdx + - page: Publishing to PyPI + path: ./overview/python/publishing-to-npm.mdx + - page: Adding custom code + path: ./overview/python/custom-code.mdx - link: Customer Showcase href: https://buildwithfern.com/showcase - section: Go contents: - page: Quickstart - path: ./pages/go/quickstart.mdx + path: ./overview/go/quickstart.mdx - page: Design Decisions - path: ./pages/go/design.mdx + path: ./overview/go/design.mdx - page: Configuration - path: ./pages/go/configuration.mdx + path: ./overview/go/configuration.mdx - page: Changelog - path: ./pages/go/changelog.mdx - - page: Publishing to NPM - path: ./pages/go/publishing-to-npm.mdx + path: ./overview/go/changelog.mdx + - page: Publishing as a Go Module + path: ./overview/go/publishing-to-npm.mdx + - page: Adding custom code + path: ./overview/go/custom-code.mdx - link: Customer Showcase href: https://buildwithfern.com/showcase - section: Java contents: - page: Quickstart - path: ./pages/java/quickstart.mdx + path: ./overview/java/quickstart.mdx - page: Design Decisions - path: ./pages/java/design.mdx + path: ./overview/java/design.mdx - page: Configuration - path: ./pages/java/configuration.mdx + path: ./overview/java/configuration.mdx - page: Changelog - path: ./pages/java/changelog.mdx - - page: Publishing to NPM - path: ./pages/java/publishing-to-npm.mdx + path: ./overview/java/changelog.mdx + - page: Publishing to Maven Central + path: ./overview/java/publishing-to-npm.mdx + - page: Adding custom code + path: ./overview/java/custom-code.mdx - link: Customer Showcase href: https://buildwithfern.com/showcase - section: .NET contents: - page: Quickstart - path: ./pages/dotnet/quickstart.mdx + path: ./overview/dotnet/quickstart.mdx - page: Design Decisions - path: ./pages/dotnet/design.mdx + path: ./overview/dotnet/design.mdx - page: Configuration - path: ./pages/dotnet/configuration.mdx + path: ./overview/dotnet/configuration.mdx - page: Changelog - path: ./pages/dotnet/changelog.mdx - - page: Publishing to NPM - path: ./pages/dotnet/publishing-to-npm.mdx + path: ./overview/dotnet/changelog.mdx + - page: Publishing to Nuget + path: ./overview/dotnet/publishing-to-npm.mdx + - page: Adding custom code + path: ./overview/dotnet/custom-code.mdx - link: Customer Showcase href: https://buildwithfern.com/showcase - section: PHP contents: - page: Quickstart - path: ./pages/php/quickstart.mdx + path: ./overview/php/quickstart.mdx - page: Design Decisions - path: ./pages/php/design.mdx + path: ./overview/php/design.mdx - page: Configuration - path: ./pages/php/configuration.mdx + path: ./overview/php/configuration.mdx - page: Changelog - path: ./pages/php/changelog.mdx - - page: Publishing to NPM - path: ./pages/php/publishing-to-npm.mdx + path: ./overview/php/changelog.mdx + - page: Publishing to Packagist + path: ./overview/php/publishing-to-npm.mdx + - page: Adding custom code + path: ./overview/php/custom-code.mdx - link: Customer Showcase href: https://buildwithfern.com/showcase - section: Ruby contents: - page: Quickstart - path: ./pages/ruby/quickstart.mdx + path: ./overview/ruby/quickstart.mdx - page: Design Decisions - path: ./pages/ruby/design.mdx + path: ./overview/ruby/design.mdx - page: Configuration - path: ./pages/ruby/configuration.mdx + path: ./overview/ruby/configuration.mdx - page: Changelog - path: ./pages/ruby/changelog.mdx - - page: Publishing to NPM - path: ./pages/ruby/publishing-to-npm.mdx + path: ./overview/ruby/changelog.mdx + - page: Publishing to RubyGems + path: ./overview/ruby/publishing-to-npm.mdx + - page: Adding custom code + path: ./overview/ruby/custom-code.mdx - link: Customer Showcase href: https://buildwithfern.com/showcase - - section: Enterprise - contents: - - page: On-Premise SDKs - path: ./pages/enterprise/on-premise-sdks.mdx - section: Guides - contents: + contents: - page: Customize Method Names - path: ./pages/guides/customize-method-names.mdx + path: ./guides/customize-method-names.mdx - page: Setup local SDK previews - path: ./pages/guides/setup-local-sdk-previews.mdx + path: ./guides/setup-local-sdk-previews.mdx - page: Configure Global Headers - path: ./pages/guides/configure-global-headers.mdx + path: ./guides/configure-global-headers.mdx - page: Configure Auto-Pagination - path: ./pages/guides/configure-auto-pagination.mdx - - page: Configure Auth Schemes - path: ./pages/guides/configure-auth-schemes.mdx - - page: Configure GitHub Publishing - path: ./pages/guides/configure-github-publishing.mdx + path: ./guides/configure-auto-pagination.mdx - page: Configure Idempotency - path: ./pages/guides/configure-idempotency.mdx + path: ./guides/configure-idempotency.mdx - page: Filter Your Endpoints (Audiences) - path: ./pages/guides/filter-your-endpoints-audiences.mdx + path: ./guides/filter-your-endpoints-audiences.mdx + - page: Self-host Fern's SDK Generators + path: ./guides/filter-your-endpoints-audiences.mdx + - section: Reference + contents: + - page: generators.yml + path: ./reference/generators-yml-reference.mdx