Skip to content

Commit ce51363

Browse files
kgowruKapil GowruKapil Gowrudevalog
authored
Generators.yml link, Update writing guide, add version numbers for sdks (#185)
Co-authored-by: Kapil Gowru <[email protected]> Co-authored-by: Kapil Gowru <[email protected]> Co-authored-by: Devin Logan <[email protected]>
1 parent 1f1eb99 commit ce51363

File tree

13 files changed

+163
-73
lines changed

13 files changed

+163
-73
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,21 +49,26 @@ Keep the following principles in mind:
4949

5050
- **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.
5151
- **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."
52-
- **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.
52+
- **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.
53+
- **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.
5354
- **Use [Fern’s documentation components](https://buildwithfern.com/learn/docs/writing-content/components/overview)** whenever you can.
5455
- **When editing an existing page** - Match the existing heading structure, tone, and level of detail to ensure your changes integrate as seamlessly as possible.
5556

56-
**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/)
57+
> "Break any of these rules sooner than say anything outright barbarous."
58+
>
59+
> —George Orwell, "Politics and the English Language"
60+
61+
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/).
5762

5863
### Getting changes reviewed
5964

6065
If you want to **add a new page or make a large structural change**:
61-
- [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.
66+
- [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.
6267

6368
For **all other changes**:
6469
- Submit a PR directly with your suggested changes. A Fern docs member will review and confirm.
6570

66-
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.
71+
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).
6772

6873

6974

fern/assets/styles.css

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,12 @@
4343
border-radius: 1.5rem !important;
4444
}
4545

46+
.product-dropdown-trigger {
47+
svg {
48+
transform: translateY(2px);
49+
}
50+
}
51+
4652
.fern-product-selector {
4753
transform: translate(-2px, 2px);;
4854
}

fern/docs.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,10 @@ redirects:
308308
destination: /learn/sdks/overview/introduction
309309
permanent: true
310310

311+
- source: /learn/sdks/reference/generators-yml-reference
312+
destination: /learn/sdks/reference/generators-yml
313+
permanent: true
314+
311315
# ============================================================================
312316
# DOCS REDIRECTS
313317
# ============================================================================

fern/products/sdks/fern-folder.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ published and configures customizations like package metadata, output locations,
8282
and generation settings.
8383

8484
<Info>
85-
See the [`generators.yml` reference page](/learn/sdks/reference/generators-yml-reference) for more information.
85+
See the [`generators.yml` reference page](/sdks/reference/generators-yml) for more information.
8686
</Info>
8787

8888
## Configure Multiple APIs
27.8 KB
Loading

fern/products/sdks/images/go-card.png

23.1 KB
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
17.4 KB
Loading
22.6 KB
Loading

0 commit comments

Comments
 (0)