Skip to content

Make README clearer and more concise #5491

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

Open
fern-api wants to merge 1 commit into
base: main
Choose a base branch
from
+36 −66
Open

Make README clearer and more concise #5491

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
102 changes: 36 additions & 66 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,123 +1,93 @@
# Fern documentation

Welcome to the Fern documentation! This repository contains the source code for Fern's comprehensive documentation site, currently live at [buildwithfern.com/learn](https://buildwithfern.com/learn).
The source for Fern's documentation, published at [buildwithfern.com/learn](https://buildwithfern.com/learn).

## Quickstart 🚀
## Quickstart

### Prerequisites

Before you begin, make sure you have the following installed:
- [Node.js](https://nodejs.org/) (version 22 or higher)
- [npm](https://www.npmjs.com/) version 10.0.0 or higher (comes with Node.js 22)
- [Node.js](https://nodejs.org/) 22 or higher (includes [npm](https://www.npmjs.com/) 10+)

### Installation
### Run the docs locally

1. **Install the Fern CLI globally:**
1. Install the Fern CLI:
```bash
npm install -g fern-api
```

2. **Clone this repository:**
2. Clone this repo and start the dev server:
```bash
git clone https://github.com/fern-api/docs.git
cd docs
```

### Editing documentation

To run the documentation site locally:

1. **Start the development server:**
```bash
fern docs dev
```
3. Open [http://localhost:3000](http://localhost:3000). The server reloads on save.

2. **Open your browser and navigate to:**
```
http://localhost:3000
```

The development server will automatically reload when you make changes to the documentation files.

Finally, when you make a PR to update the docs, a PR preview link will be generated which will allow you
to test if your changes came out as intended. [Here](https://github.com/fern-api/docs/pull/1784) is a sample PR with a preview link.
Every PR also gets a preview link so you can verify your changes before merge ([example](https://github.com/fern-api/docs/pull/1784)).

## Contribution guide

Thanks for contributing to Fern's documentation!
Thanks for contributing!

### Writing tips

Keep the following principles in mind:
- **Write for your audience.** Explain the use case, focus on clarity, and add examples or code snippets where they help.
- **Help users get something done.** Skip marketing language like "amazing features" or "the best solution."
- **Avoid time-specific language** ("just released", "newest"). It ages badly.
- **Use clear, concise [active voice](https://developers.google.com/style/voice).** Short sentences, friendly tone, minimal jargon.
- **Use [Fern's documentation components](https://buildwithfern.com/learn/docs/writing-content/components/overview)** wherever you can.
- **When editing an existing page,** match its heading structure, tone, and level of detail.
- **Show, don't tell.** Use [Mermaid](https://buildwithfern.com/learn/docs/writing-content/markdown-media#diagrams) diagrams to illustrate workflows.
- **Use [sentence case](https://developers.google.com/style/capitalization)** for headings.

- **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. Use a 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.
- **Use diagrams when it makes sense** – Show, don't tell! Use [Mermaid](https://buildwithfern.com/learn/docs/writing-content/markdown-media#diagrams), a Markdown-like diagramming syntax, to illustrate a workflow.
- [**Use sentence case**](https://developers.google.com/style/capitalization) for page and section headings.
Our style 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/).

> "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/).

### Style checking with Vale

We use [Vale](https://vale.sh/docs) to check contributions for grammar, style consistency, and adherence to our writing guidelines. Our [Vale configuration](https://github.com/fern-api/docs/blob/main/.vale.ini) uses the [Microsoft style guide](https://github.com/errata-ai/Microsoft) plus custom rules for Fern's style and terminology.

Vale runs automatically on PRs that modify `.mdx` files and comments with style suggestions (non-blocking).
We use [Vale](https://vale.sh/docs) to check `.mdx` files for grammar and style. Our [config](https://github.com/fern-api/docs/blob/main/.vale.ini) extends the [Microsoft style guide](https://github.com/errata-ai/Microsoft) with Fern-specific rules. Vale runs automatically on PRs (non-blocking).

<details>
<summary>Style guidelines enforced by Vale</summary>

The Vale linter enforces the following style guidelines:

**Language and tone**
- Avoid unnecessary adverbs (very, really, extremely, etc.) that don't add meaning
- Don't use "please" in technical documentation
- Use first person (I, me) sparingly
- Avoid first-person plural (we, our, let's)
- Avoid unnecessary adverbs (very, really, extremely)
- Don't use "please"
- Use first person (I, me) sparingly; avoid "we", "our", "let's"
- Write in an objective, instructional tone

**Time-relative language**
- Avoid terms that become outdated: currently, presently, now, future, soon, latest, upcoming, old
- Write documentation that remains accurate over time
- Avoid terms that age: currently, presently, now, future, soon, latest, upcoming, old

**Headings**
- Use sentence-case capitalization (capitalize only the first word and proper nouns)
- Don't use end punctuation (periods, question marks, exclamation points)
- Sentence case (capitalize only the first word and proper nouns)
- No end punctuation

**Acronyms**
- Define acronyms on first use unless they're in the exceptions list (common technical acronyms like API, SDK, CLI, HTTP, JSON, etc.)
- Format: "Application Programming Interface (API)"
- Define on first use, e.g., "Application Programming Interface (API)". Common acronyms like API, SDK, CLI, HTTP, and JSON are exempt.

**Terminology**
- Use "Fern Editor" instead of "Visual Editor"
- Use "API Reference" (capitalized) consistently
- Use "API Explorer" (capitalized) consistently
- Use "Fern Editor" (not "Visual Editor")
- Use "API Reference" and "API Explorer" — capitalized

**Formatting**
- Don't hyphenate adverbs ending in -ly (e.g., "quickly moving" not "quickly-moving")
- Don't hyphenate adverbs ending in -ly (e.g., "quickly moving")
</details>

<details>
<summary>Use Vale locally</summary>
To catch issues earlier in your workflow, set up Vale to run automatically on your machine when you commit:
<summary>Run Vale locally</summary>

Catch issues before you commit:

1. Install pre-commit: `brew install pre-commit`
2. Install the hook: `pre-commit install`
</details>

### 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). 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.
- **New page or large structural change:** [file an issue](https://github.com/fern-api/docs/issues) and assign [@devalog](https://github.com/devalog) so we can confirm it fits the docs strategy.
- **All other changes:** open a PR directly — a Fern docs member will review.

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).
Spotted something wrong 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).
Loading