Skip to content

Commit a0a9814

Browse files
committed
docs: add README
1 parent aa5012d commit a0a9814

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# APIForge — Documentation
2+
3+
**Source of the [APIForge documentation site](https://apiforge-organisation.github.io/docs/).**
4+
5+
[![Deploy](https://img.shields.io/github/actions/workflow/status/APIForge-Organisation/docs/deploy.yml?branch=main&label=Deploy)](https://github.com/APIForge-Organisation/docs/actions)
6+
[![Live](https://img.shields.io/badge/docs-live-0066FF)](https://apiforge-organisation.github.io/docs/)
7+
8+
---
9+
10+
## What's in here
11+
12+
| Path | Content |
13+
|---|---|
14+
| `docs/index.md` | Homepage |
15+
| `docs/guide/` | Getting started, configuration, dashboard |
16+
| `docs/features/` | Health Score, Insights, Release Tracking |
17+
| `docs/.vitepress/config.js` | Site navigation and theme config |
18+
19+
Built with [VitePress](https://vitepress.dev). Deployed automatically to GitHub Pages on every push to `main`.
20+
21+
## Local development
22+
23+
```bash
24+
npm install
25+
npm run dev
26+
```
27+
28+
Then open **http://localhost:5173/docs/**.
29+
30+
## Deployment
31+
32+
Any push to `main` triggers the [deploy workflow](.github/workflows/deploy.yml), which builds the site and publishes it to GitHub Pages. No manual step required.
33+
34+
---
35+
36+
**[apiforge-organisation.github.io/docs](https://apiforge-organisation.github.io/docs/)**

0 commit comments

Comments
 (0)