Quickstart

Edit an Existing Page

Every doc page has an “Edit page” link in the footer. Click it to open the file directly in GitLab. Make your changes and submit a merge request.

To edit locally:

1. Clone the repository and run npm install
2. Start the dev server with npm run dev
3. Find the file in src/content/docs/ and edit it
4. The browser reloads automatically as you save

Add a New Page

1. Create a .md file in the appropriate directory under src/content/docs/:

src/content/docs/business/hr/hiring/my-new-page.md

1. Add the required frontmatter:

---
title: My New Page
description: What this page covers.
---

Content here.

1. If the department uses autogenerate in sidebar.json, the page appears in the sidebar automatically. If it uses explicit slugs, add your page:

{ "label": "My New Page", "slug": "business/hr/hiring/my-new-page" }

Restart Required

Changes to sidebar.json or astro.config.mjs require restarting the dev server (Ctrl+C, then npm run dev). Content file changes hot-reload automatically.

File Naming

Use lowercase kebab-case for all file and directory names:

hiring/career-growth.md    ✅
hiring/CareerGrowth.md     ❌
hiring/career_growth.md    ❌

See Nomenclature for the full naming conventions.