Skip to content

Add Contribution Guide to docs repo README #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add Contribution Guide to docs repo README #168

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.