How to Update These Docs

This page shows where to make changes, how to propose them, and exact MDX snippets you can copy

Where to Edit

Docs live under this repo’s content folder
Most shared assets (images, logos, memes) go in /public/images/ and are referenced by path

How to Propose Changes

Create a branch: git checkout -b docs/<short-slug>
Edit or add .mdx files (use the snippets below)
Run locally and verify: pnpm run dev
Open a PR using the PR template

Style Rules

Link to deeper pages; avoid duplicating content
Put images in /public/images/...
Start every page with front-matter
Keep filenames kebab-case: how-to-update.mdx

New Page Template


---
title: Page Title
description: One-line summary of the page.
---
 
# Page Title
 
Short intro. Link to related pages when helpful.

Headings


# H1 — page title (use once)
## H2 — major section
### H3 — subsection
#### H4 — rarely needed

Text, Lists, Checklists


**Bold**, *italic*, `inline code`, and a [link](/onboarding).
 
- Unordered list item
- Another item
 
1. Ordered item
2. Another item
 
- [ ] To-do (unchecked)
- [x] To-do (done)

Code Blocks


export function hello(name: string) {
  return `Hello, ${name}`;
}

Rendered example:

Click to expand deployment steps

Merge PR to main Wait for CI to deploy Smoke test key flows

How to write it


<details>
  <summary>Click to expand deployment steps</summary>
 
  1. Merge PR to `main`  
  2. Wait for CI to deploy  
  3. Smoke test key flows
</details>

Images

Put files in /public/images/...


![Alt text](/images/diagrams/architecture.webp)

Tables


| Role      | Responsibility          |
|-----------|--------------------------|
| Frontend  | UI, accessibility, UX    |
| Backend   | APIs, services, DB       |
| Infra     | CI/CD, IaC, monitoring   |

Callouts


> **Note:** Keep secrets out of screenshots and logs.

Internal vs External Links


[Onboarding](/onboarding)        <!-- internal absolute path -->
[GitHub Org](https://github.com/PeerRated)  <!-- external -->