diff --git a/README.md b/README.md index 4fa7833ee..c7cf690b2 100644 --- a/README.md +++ b/README.md @@ -49,21 +49,26 @@ Keep the following principles in mind: - **Write for your audience** - Consider why users are reading your documentation and explain the use case clearly. Focus on clarity and completeness without being verbose. Add examples and code snippets when relevant. - **Help users get something done**. Don't try to sell users on the product, and avoid marketing language like "amazing features" or "the best solution." -- **Write in clear, concise language**, using [active voice](https://developers.google.com/style/voice) whenever possible. Keep sentences and paragraphs short and to the point. Use a friendly, casual tone and stay away from jargon as much as you can. +- **Avoid time-specific language**. Don't mention a product or feature was just released or is the newest form, as this will quickly lead to stale documentation. +- **Write in clear, concise language**, using [active voice](https://developers.google.com/style/voice) whenever possible. Keep sentences and paragraphs short and to the point. Be conversational and friendly tone. Stay away from jargon as much as you can. - **Use [Fern’s documentation components](https://buildwithfern.com/learn/docs/writing-content/components/overview)** whenever you can. - **When editing an existing page** - Match the existing heading structure, tone, and level of detail to ensure your changes integrate as seamlessly as possible. -**For language and grammar help**, check out [Google's developer documentation style guide](https://developers.google.com/style) or Microsoft's [writing style guide](https://learn.microsoft.com/en-us/style-guide/welcome/) +> "Break any of these rules sooner than say anything outright barbarous." +> +> —George Orwell, "Politics and the English Language" + +Our style guide is influenced by [Google's developer documentation style guide](https://developers.google.com/style) and Microsoft's [writing style guide](https://learn.microsoft.com/en-us/style-guide/welcome/). ### Getting changes reviewed If you want to **add a new page or make a large structural change**: -- [File an issue in GitHub](https://github.com/fern-api/docs/issues) and assign @devalog and @kgowru. We'll review your issue to make sure your proposed page fits with Fern's overall documentation strategy and isn't duplicating any ongoing work. +- [File an issue in GitHub](https://github.com/fern-api/docs/issues) and assign [@devalog](https://github.com/devalog), [@kgowru](https://github.com/kgowru), or [@dsinghvi](https://github.com/dsinghvi). We'll review your issue to make sure your proposed page fits with Fern's overall documentation strategy and isn't duplicating any ongoing work. For **all other changes**: - Submit a PR directly with your suggested changes. A Fern docs member will review and confirm. -If you see something that is wrong or outdated in the documentation but don't know how to fix it, [file an issue](https://github.com/fern-api/docs/issues) or reach out to @devalog and @kgowru. +If you see something that is wrong or outdated in the documentation but don't know how to fix it, [file an issue](https://github.com/fern-api/docs/issues) or reach out to [@devalog](https://github.com/devalog), [@kgowru](https://github.com/kgowru), or [@dsinghvi](https://github.com/dsinghvi). diff --git a/fern/assets/styles.css b/fern/assets/styles.css index e0d70c324..e1a9d5349 100644 --- a/fern/assets/styles.css +++ b/fern/assets/styles.css @@ -43,6 +43,12 @@ border-radius: 1.5rem !important; } + .product-dropdown-trigger { + svg { + transform: translateY(2px); + } + } + .fern-product-selector { transform: translate(-2px, 2px);; } diff --git a/fern/docs.yml b/fern/docs.yml index f526008f8..8ae0985c8 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -308,6 +308,10 @@ redirects: destination: /learn/sdks/overview/introduction permanent: true + - source: /learn/sdks/reference/generators-yml-reference + destination: /learn/sdks/reference/generators-yml + permanent: true + # ============================================================================ # DOCS REDIRECTS # ============================================================================ diff --git a/fern/products/sdks/fern-folder.mdx b/fern/products/sdks/fern-folder.mdx index 02be7ced0..1b42e9412 100644 --- a/fern/products/sdks/fern-folder.mdx +++ b/fern/products/sdks/fern-folder.mdx @@ -82,7 +82,7 @@ published and configures customizations like package metadata, output locations, and generation settings. - See the [`generators.yml` reference page](/learn/sdks/reference/generators-yml-reference) for more information. + See the [`generators.yml` reference page](/sdks/reference/generators-yml) for more information. ## Configure Multiple APIs diff --git a/fern/products/sdks/images/csharp-card.png b/fern/products/sdks/images/csharp-card.png index 5a9baba25..e4d3f90bc 100644 Binary files a/fern/products/sdks/images/csharp-card.png and b/fern/products/sdks/images/csharp-card.png differ diff --git a/fern/products/sdks/images/go-card.png b/fern/products/sdks/images/go-card.png index 7203cdf6a..b8773d38c 100644 Binary files a/fern/products/sdks/images/go-card.png and b/fern/products/sdks/images/go-card.png differ diff --git a/fern/products/sdks/images/icons/changelog-icon-dark.svg b/fern/products/sdks/images/icons/changelog-icon-dark.svg new file mode 100644 index 000000000..138b2c473 --- /dev/null +++ b/fern/products/sdks/images/icons/changelog-icon-dark.svg @@ -0,0 +1,3 @@ + + + diff --git a/fern/products/sdks/images/icons/changelog-icon.svg b/fern/products/sdks/images/icons/changelog-icon.svg new file mode 100644 index 000000000..2b3293fe2 --- /dev/null +++ b/fern/products/sdks/images/icons/changelog-icon.svg @@ -0,0 +1,3 @@ + + + diff --git a/fern/products/sdks/images/php-card.png b/fern/products/sdks/images/php-card.png index 1c7ef84d4..1d31bd235 100644 Binary files a/fern/products/sdks/images/php-card.png and b/fern/products/sdks/images/php-card.png differ diff --git a/fern/products/sdks/images/python-card.png b/fern/products/sdks/images/python-card.png index 7fd45b9a5..e6ceb2f3b 100644 Binary files a/fern/products/sdks/images/python-card.png and b/fern/products/sdks/images/python-card.png differ diff --git a/fern/products/sdks/images/ruby-card.png b/fern/products/sdks/images/ruby-card.png index a28aa8a60..30b5b190d 100644 Binary files a/fern/products/sdks/images/ruby-card.png and b/fern/products/sdks/images/ruby-card.png differ diff --git a/fern/products/sdks/images/typescript-card-dark.svg b/fern/products/sdks/images/typescript-card-dark.svg deleted file mode 100644 index 09b07f46f..000000000 --- a/fern/products/sdks/images/typescript-card-dark.svg +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/fern/products/sdks/introduction.mdx b/fern/products/sdks/introduction.mdx index 614a8103e..48a04b75e 100644 --- a/fern/products/sdks/introduction.mdx +++ b/fern/products/sdks/introduction.mdx @@ -3,8 +3,52 @@ title: SDKs Overview description: Generate idiomatic SDKs in multiple programming languages --- + +
- {/* Dashed Pattern - Left Side */} +{/* Dashed Pattern - Left Side */}
{/*
*/}
@@ -18,12 +62,25 @@ description: Generate idiomatic SDKs in multiple programming languages
TypeScript -
+ +
TypeScript Arrow right light Arrow right light
+
+
+ v +
+ + Changelog + Changelog +
+ Changelog +
+ +
@@ -31,12 +88,24 @@ description: Generate idiomatic SDKs in multiple programming languages
Python -
+
Python Arrow right light Arrow right light
+
+
+ v +
+ + Changelog + Changelog +
+ Changelog +
+ +
@@ -44,12 +113,24 @@ description: Generate idiomatic SDKs in multiple programming languages
Go -
+
Go Arrow right light Arrow right light
+
+
+ v +
+ + Changelog + Changelog +
+ Changelog +
+ +
@@ -57,12 +138,24 @@ description: Generate idiomatic SDKs in multiple programming languages
Java -
+
Java Arrow right light Arrow right light
+
+
+ v +
+ + Changelog + Changelog +
+ Changelog +
+ +
@@ -70,12 +163,24 @@ description: Generate idiomatic SDKs in multiple programming languages
.NET -
+
.NET Arrow right light Arrow right light
+
+
+ v +
+ + Changelog + Changelog +
+ Changelog +
+ +
@@ -83,12 +188,24 @@ description: Generate idiomatic SDKs in multiple programming languages
PHP -
+
PHP Arrow right light Arrow right light
+
+
+ v +
+ + Changelog + Changelog +
+ Changelog +
+ +
@@ -96,12 +213,24 @@ description: Generate idiomatic SDKs in multiple programming languages
Ruby -
+
Ruby Arrow right light Arrow right light
+
+
+ v +
+ + Changelog + Changelog +
+ Changelog +
+ +