Skip to content

Commit 50bf479

Browse files
authored
add proposal states, syntax highlighting (#18)
1 parent cb3e406 commit 50bf479

File tree

9 files changed

+422
-56
lines changed

9 files changed

+422
-56
lines changed

CLAUDE.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,15 @@ Static site generator for Vortex RFC proposals built with Bun.
77
```
88
index.ts - Main build script and dev server
99
styles.css - Site styling (light/dark themes)
10-
proposals/ - RFC markdown files (format: NNNN-slug.md)
10+
proposed/ - RFC markdown files in proposed state
11+
accepted/ - RFC markdown files in accepted state
12+
completed/ - RFC markdown files in completed state
1113
dist/ - Build output (gitignored)
1214
```
1315

16+
RFC filenames follow the format `NNNN-slug.md` (e.g., `0001-galp-patches.md`).
17+
Numbering is global across all states - no duplicates allowed.
18+
1419
## Commands
1520

1621
```sh
@@ -21,19 +26,30 @@ bun run clean # Remove dist/
2126

2227
## How the Build Works
2328

24-
1. Scans `proposals/*.md` for RFC files
29+
1. Scans `proposed/`, `accepted/`, `completed/` for RFC files
2530
2. Parses RFC number from filename (e.g., `0002-foo.md` → RFC 0002)
26-
3. Extracts title from first `# ` heading
27-
4. Converts markdown to HTML using `Bun.markdown.html()`
28-
5. Generates `dist/index.html` (table of contents)
29-
6. Generates `dist/rfc/{number}.html` for each RFC
31+
3. Determines state from containing folder
32+
4. Extracts title from first `# ` heading
33+
5. Converts markdown to HTML using `Bun.markdown.html()`
34+
6. Generates `dist/index.html` (table of contents with filter UI)
35+
7. Generates `dist/rfc/{number}.html` for each RFC
3036

3137
## Dev Server
3238

3339
- Uses `Bun.serve()` to serve static files from `dist/`
34-
- Watches `proposals/` and `styles.css` for changes
40+
- Watches `proposed/`, `accepted/`, `completed/`, and `styles.css` for changes
3541
- SSE endpoint at `/__reload` for live reload
3642

43+
## RFC States
44+
45+
RFCs progress through three states by moving files between folders:
46+
47+
- **proposed**: New RFCs under discussion
48+
- **accepted**: Approved RFCs ready for implementation
49+
- **completed**: Fully implemented RFCs
50+
51+
The index page shows a state pill for each RFC and supports filtering by state.
52+
3753
## Styling
3854

3955
- CSS custom properties for theming (`--bg`, `--fg`, `--link`, etc.)

accepted/.keep

Whitespace-only changes.
Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
- Start Date: (today's date, YYYY-MM-DD)
2-
- RFC PR: [vortex-data/rfcs#0000](https://github.com/vortex-data/rfcs/pull/0000)
32
- Tracking Issue: [vortex-data/vortex#0000](https://github.com/vortex-data/vortex/issues/0000)
43

54
## Summary
@@ -23,7 +22,14 @@ Describe the proposed design in enough detail that someone familiar with Vortex
2322
- Why is this the best approach in the space of possible designs?
2423
- Which crates are affected and how the dependency graph changes, if at all.
2524

26-
Use code examples and diagrams where they might help.
25+
Use code examples and diagrams where they might help, like this:
26+
27+
```rust
28+
pub fn main() {
29+
let x = f32::to_bits(100.0f32);
30+
dbg!(x);
31+
}
32+
```
2733

2834
## Compatibility
2935

bun.lock

Lines changed: 94 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

completed/.keep

Whitespace-only changes.

0 commit comments

Comments
 (0)