Skip to content

README.md

Latest commit

 

History

History
63 lines (46 loc) · 1.58 KB

README.md

File metadata and controls

63 lines (46 loc) · 1.58 KB

Trunk Docs

This repository contains the documentation site for Trunk, powered by Fern.

Repository Structure

fern/
├── fern.config.json          # Fern project configuration
├── docs.yml                  # Documentation site layout, navigation, and styling
├── apis/
│   ├── flaky-tests-api/
│   │   ├── openapi.yml       # Flaky Tests API spec
│   │   └── generators.yml    # Generator config
│   └── merge-queue-api/
│       ├── openapi.yml       # Merge Queue API spec
│       └── generators.yml    # Generator config
└── docs/
    ├── assets/               # Logos and favicon
    └── pages/                # Documentation content (MDX)
        ├── merge-queue/
        ├── flaky-tests/
        ├── ci-autopilot/
        ├── code-quality/
        └── setup/

Prerequisites

Install the Fern CLI:

npm install -g fern-api

Development

Preview the docs locally:

fern docs dev

This starts a local development server so you can see changes in real time.

Generating the Docs

To generate and publish the documentation site:

fern generate --docs

Editing Content

  • Pages are written in MDX and live in fern/docs/pages/.
  • Navigation and layout are configured in fern/docs.yml.
  • API references are auto-generated from the OpenAPI specs in fern/apis/.

Useful Links