Skip to content

Commit 054aeaf

Browse files
authored
feat: /releases page (#1608)
1 parent 4d7ec3b commit 054aeaf

File tree

9 files changed

+650
-6
lines changed

9 files changed

+650
-6
lines changed

CLAUDE.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4+
5+
## Project Overview
6+
7+
This is the official documentation website for Foundry, a smart contract development toolchain for Ethereum. The documentation is built using Vocs (a React-based documentation framework) and deployed to Cloudflare Pages.
8+
9+
## Essential Commands
10+
11+
### Development
12+
```bash
13+
cd vocs
14+
bun install # Install dependencies
15+
bun dev # Start development server (default: http://localhost:5173)
16+
bun build # Build documentation for production
17+
bun preview # Preview production build locally
18+
bun check-links # Validate all internal documentation links
19+
```
20+
21+
### Generating CLI Output
22+
```bash
23+
# From project root - generates auto-generated CLI command outputs
24+
./scripts/gen_output.sh # Requires Foundry tools (forge, cast, anvil, chisel) installed
25+
```
26+
27+
## Architecture & Structure
28+
29+
### Key Directories
30+
- `/vocs/` - Main documentation source directory
31+
- `/docs/pages/` - All documentation content in MDX format, organized by tool:
32+
- `/forge/` - Smart contract compilation and testing documentation
33+
- `/cast/` - Ethereum RPC client documentation
34+
- `/anvil/` - Local Ethereum node documentation
35+
- `/chisel/` - Solidity REPL documentation
36+
- `/docs/public/` - Static assets (images, diagrams)
37+
- `/sidebar/` - Navigation configuration (sidebar.ts and modular sections)
38+
- `/docs/snippets/` - Code examples and auto-generated outputs
39+
40+
### Configuration Files
41+
- `vocs/vocs.config.ts` - Main Vocs configuration (theme, navigation, sponsors)
42+
- `vocs/sidebar/sidebar.ts` - Main sidebar navigation structure
43+
- `vocs/package.json` - Dependencies and scripts
44+
45+
### Documentation Patterns
46+
- MDX files support frontmatter for metadata
47+
- Code snippets are pulled from `/docs/snippets/projects/` test projects
48+
- Auto-generated CLI outputs stored in `/docs/snippets/output/`
49+
- Images and assets organized by topic in `/docs/public/`
50+
51+
## Contributing Guidelines
52+
53+
When adding or modifying documentation:
54+
1. Chapters start with second-level headings (`##`)
55+
2. Use "we" not "I" in documentation
56+
3. Use auto-generated CLI output where possible (run `./scripts/gen_output.sh`)
57+
4. Include source files from the projects folder rather than inline code
58+
5. Run `bun check-links` before committing to ensure all links are valid
59+
60+
## Deployment
61+
62+
The documentation automatically deploys to Cloudflare Pages via GitHub Actions on push to the main branch. The deployment workflow handles building and publishing to the "foundry-book" Cloudflare Pages project.

vocs/bun.lockb

0 Bytes
Binary file not shown.

vocs/docs/pages/releases.mdx

Lines changed: 240 additions & 0 deletions
Large diffs are not rendered by default.

vocs/docs/pages/releases/nightly.mdx

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Foundry Nightly Release
3+
description: Latest nightly release notes for Foundry
4+
---
5+
6+
# Nightly (2025-07-23) [July 23, 2025]
7+
8+
9+
## Other
10+
11+
- feat: use signatures identifier for --print-traces ([#11070](https://github.com/foundry-rs/foundry/pull/11070)) by [@mattsse](https://github.com/mattsse)
12+
- feat: use alloy-evm apply overrides ([#11071](https://github.com/foundry-rs/foundry/pull/11071)) by [@mattsse](https://github.com/mattsse)
13+
14+
## Full Changelog:
15+
https://github.com/foundry-rs/foundry/compare/nightly...nightly-cb8f3bf2c4047f17310b84a685fcc12b61c98891
16+
17+
---
18+
19+
*This page is automatically updated with the latest release information from the [Foundry GitHub repository](https://github.com/foundry-rs/foundry/releases).*

vocs/docs/pages/releases/stable.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Foundry Stable Release
3+
description: Latest stable release notes for Foundry
4+
---
5+
6+
*This page is automatically updated with the latest release information from the [Foundry GitHub repository](https://github.com/foundry-rs/foundry/releases).*

vocs/package.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@
55
"type": "module",
66
"scripts": {
77
"dev": "vocs dev",
8-
"build": "vocs build",
9-
"preview": "vocs preview",
10-
"check-links": "bun check-links.ts"
8+
"build": "bun run fetch-releases && vocs build",
9+
"preview": "bun run build && vocs preview",
10+
"check-links": "bun check-links.ts",
11+
"fetch-releases": "bun scripts/fetch-releases.ts"
1112
},
1213
"dependencies": {
1314
"react": "latest",
@@ -19,4 +20,4 @@
1920
"@types/react": "latest",
2021
"typescript": "latest"
2122
}
22-
}
23+
}

0 commit comments

Comments
 (0)