Introduction
Contributing to the Field Guide
How to add and edit pages in this documentation site.
This page covers the editorial workflow for the Field Guide itself.
Editing via Nuxt Studio
The Field Guide is configured with Nuxt Studio for browser-based editing with Google OAuth. Visit the Studio dashboard to edit pages without cloning the repo.
Editing Locally
Prerequisites
- Node.js 20+, npm
Setup
git clone https://github.com/coral-gardeners/coral-gardeners-docs.git
cd coral-gardeners-docs
npm install
npm run dev
The site runs at http://localhost:3000.
Content Conventions
File Organisation
Content lives in content/ with numeric prefixes for ordering:
content/
├── 1.introduction/
├── 2.methodology/
└── 3.glossary/
Each section folder has a .navigation.yml with title and icon.
Frontmatter
Every page needs these fields:
---
title: Page Title
description: One-line summary for SEO and search.
navigation:
icon: i-lucide-icon-name
owner: efe # efe | hannah | rich | team
status: active # stable | active | draft
last_reviewed: "2026-02-20"
---
Linking
Use URL paths without numeric prefixes:
[Fragment](/glossary/reef-biology/fragment) ✅
[Fragment](/3.glossary/1.reef-biology/1.fragment) ❌
Icons
- UI icons:
i-lucide-* - Brand icons:
i-simple-icons-*