From 1a6c2acea886be967e6c0e0d0e919c5df379ddbd Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Thu, 24 Jul 2025 18:58:47 -0400 Subject: [PATCH] add contribution guide to readme --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 83638df47..4fa7833ee 100644 --- a/README.md +++ b/README.md @@ -39,3 +39,32 @@ To run the documentation site locally: The development server will automatically reload when you make changes to the documentation files. +## Contribution Guide + +Thanks for contributing to Fern's documentation! + +### Writing tips + +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. +- **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/) + +### 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. + +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. + + + +