https://github.com/fern-api/docs
Documentation for Fern
https://github.com/fern-api/docs
built-with-fern docs docs-as-code
Last synced: 6 months ago
JSON representation
Documentation for Fern
- Host: GitHub
- URL: https://github.com/fern-api/docs
- Owner: fern-api
- License: apache-2.0
- Created: 2025-06-14T13:17:27.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-07-29T17:19:57.000Z (6 months ago)
- Last Synced: 2025-07-29T17:27:16.622Z (6 months ago)
- Topics: built-with-fern, docs, docs-as-code
- Language: MDX
- Homepage: https://buildwithfern.com/learn/v2
- Size: 85.8 MB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fern Documentation
Welcome to the Fern documentation! This repository contains the source code for Fern's comprehensive documentation site, currently live at [fern-api.docs.buildwithfern.com/learn/home](https://fern-api.docs.buildwithfern.com/learn/home).
## 🚀 Quick Start
### Prerequisites
Before you begin, make sure you have the following installed:
- [Node.js](https://nodejs.org/) (version 16 or higher)
- [npm](https://www.npmjs.com/) (comes with Node.js)
### Installation
1. **Install the Fern CLI globally:**
```bash
npm install -g fern-api
```
2. **Clone this repository:**
```bash
git clone
cd docs
```
### Local Development
To run the documentation site locally:
1. **Start the development server:**
```bash
fern docs dev
```
2. **Open your browser and navigate to:**
```
http://localhost:3000
```
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."
- **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.
> "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](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](https://github.com/devalog), [@kgowru](https://github.com/kgowru), or [@dsinghvi](https://github.com/dsinghvi).