Skip to content

Commit 2e09847

Browse files
committed
Merge branch 'agents/populate-readme-todo-section'
2 parents a1afb69 + 8202664 commit 2e09847

1 file changed

Lines changed: 44 additions & 1 deletion

File tree

README.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,50 @@
44
[![Join the chat](https://img.shields.io/badge/Chat-UserFrosting-brightgreen?logo=Rocket.Chat)](https://chat.userfrosting.com)
55
[![Donate](https://img.shields.io/badge/Ko--fi-Donate-blue?logo=ko-fi&logoColor=white)](https://ko-fi.com/lcharette)
66

7-
TODO
7+
This repository contains the source for the [UserFrosting Learn](https://learn6.userfrosting.com) documentation website — the official documentation hub for [UserFrosting](https://github.com/userfrosting/UserFrosting).
8+
9+
The site is built on **UserFrosting 6** and serves versioned Markdown documentation pages from `app/pages/{version}/`. The frontend uses **Vite** and **Vue 3** with the Pink Cupcake theme.
10+
11+
## Running Locally
12+
13+
**Without Docker:**
14+
```bash
15+
# Terminal 1 – PHP backend
16+
php bakery serve
17+
18+
# Terminal 2 – Vite dev server
19+
npm run vite:dev
20+
```
21+
22+
**With Docker:**
23+
```bash
24+
docker compose up -d
25+
```
26+
27+
The app is available at `http://localhost:8080`.
28+
29+
## Building & Testing
30+
31+
```bash
32+
# Frontend
33+
npm run vite:build # Production build
34+
npm run typecheck # TypeScript type checking
35+
npm run lint # ESLint (auto-fix)
36+
npm run test # Vitest unit tests
37+
npm run coverage # Coverage report
38+
39+
# Backend
40+
vendor/bin/phpunit # PHPUnit tests
41+
vendor/bin/phpstan # Static analysis
42+
```
43+
44+
## Contributing Documentation
45+
46+
Documentation pages live in `app/pages/{version}/` as Markdown files (e.g. `app/pages/6.0/01.quick-start/docs.md`). Folder numeric prefixes control sidebar ordering.
47+
48+
- Standalone pages use `docs.md`; chapter landing pages use `chapter.md`
49+
- Images must be stored alongside pages and referenced with an absolute path starting with `/` (e.g. `/images/screenshot.png`)
50+
- Internal links use absolute paths without version numbers (e.g. `/installation/requirements`)
851

952
## Markdown Syntax
1053

0 commit comments

Comments
 (0)