Skip to content

Commit d3af564

Browse files
committed
Update documentation for local serving
1 parent 9540352 commit d3af564

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

docs/README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,22 @@ This directory contains the source files for the SWT-Bench leaderboard website t
1111
- `approaches.csv` - Approach/paper mapping data
1212
- `static/` - Static assets (CSS, JS, images)
1313

14+
## Serving Locally
15+
16+
To generate the site locally:
17+
18+
```bash
19+
cd docs
20+
python generate_index.py
21+
```
22+
23+
This will create/update the `index.html` file based on the current CSV data and template.
24+
25+
You can serve this using the Python built-in HTTP library:
26+
```bash
27+
python -m http.server 8080
28+
```
29+
1430
## Automatic Deployment
1531

1632
The site is automatically built and deployed to GitHub Pages via the `.github/workflows/deploy-pages.yml` workflow:
@@ -23,17 +39,6 @@ The site is automatically built and deployed to GitHub Pages via the `.github/wo
2339
- Uploads the entire `docs/` directory as a Pages artifact
2440
3. **Deployment**: Deploys to GitHub Pages (only on pushes to `main`)
2541

26-
## Manual Generation
27-
28-
To generate the site locally:
29-
30-
```bash
31-
cd docs
32-
python generate_index.py
33-
```
34-
35-
This will create/update the `index.html` file based on the current CSV data and template.
36-
3742
## GitHub Pages Configuration
3843

3944
Make sure GitHub Pages is configured in your repository settings:

0 commit comments

Comments
 (0)