Skip to content

Commit cc2c4f2

Browse files
Update README with local dev and project structure docs
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 9678d87 commit cc2c4f2

1 file changed

Lines changed: 60 additions & 2 deletions

File tree

README.md

Lines changed: 60 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,60 @@
1-
# website
2-
webisite
1+
# AgentEvals Website
2+
3+
The official website for [AgentEvals](https://github.com/agentevals-dev/agentevals) — score agent behavior from OpenTelemetry traces without re-running the agent.
4+
5+
🌐 **Live site:** https://agentevals-dev.github.io/website/
6+
7+
## Prerequisites
8+
9+
- [Hugo](https://gohugo.io/installation/) v0.154+ (extended edition)
10+
11+
## Local Development
12+
13+
```bash
14+
# Clone the repo
15+
git clone https://github.com/agentevals-dev/website.git
16+
cd website
17+
18+
# Start the dev server
19+
hugo server
20+
21+
# Open http://localhost:1313
22+
```
23+
24+
The dev server supports hot reload — changes to templates, content, and styles are reflected instantly.
25+
26+
## Build for Production
27+
28+
```bash
29+
hugo --minify
30+
```
31+
32+
Output is written to the `public/` directory.
33+
34+
## Deployment
35+
36+
The site deploys automatically to GitHub Pages via GitHub Actions on every push to `main`.
37+
38+
## Project Structure
39+
40+
```
41+
.
42+
├── content/
43+
│ ├── _index.md # Homepage content
44+
│ └── docs/ # Documentation pages
45+
│ ├── quick-start.md
46+
│ ├── configuration.md
47+
│ ├── examples.md
48+
│ ├── ci-cd.md
49+
│ ├── mcp-server.md
50+
│ └── web-ui.md
51+
├── layouts/
52+
│ ├── index.html # Homepage template
53+
│ ├── _default/baseof.html # Base template (head, scripts)
54+
│ └── docs/ # Docs templates
55+
├── static/
56+
│ ├── css/style.css # All styles
57+
│ └── images/ # Logo assets
58+
├── hugo.toml # Site configuration
59+
└── .github/workflows/ # GitHub Pages deploy
60+
```

0 commit comments

Comments
 (0)