Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 23 additions & 7 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,15 @@ Static site generator for Vortex RFC proposals built with Bun.
```
index.ts - Main build script and dev server
styles.css - Site styling (light/dark themes)
proposals/ - RFC markdown files (format: NNNN-slug.md)
proposed/ - RFC markdown files in proposed state
accepted/ - RFC markdown files in accepted state
completed/ - RFC markdown files in completed state
dist/ - Build output (gitignored)
```

RFC filenames follow the format `NNNN-slug.md` (e.g., `0001-galp-patches.md`).
Numbering is global across all states - no duplicates allowed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe we are doing this by PR number


## Commands

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

## How the Build Works

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

## Dev Server

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

## RFC States

RFCs progress through three states by moving files between folders:

- **proposed**: New RFCs under discussion
- **accepted**: Approved RFCs ready for implementation
- **completed**: Fully implemented RFCs

The index page shows a state pill for each RFC and supports filtering by state.

## Styling

- CSS custom properties for theming (`--bg`, `--fg`, `--link`, etc.)
Expand Down
Empty file added accepted/.keep
Empty file.
10 changes: 8 additions & 2 deletions proposals/0000-template.md → accepted/0000-template.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
- Start Date: (today's date, YYYY-MM-DD)
- RFC PR: [vortex-data/rfcs#0000](https://github.com/vortex-data/rfcs/pull/0000)
- Tracking Issue: [vortex-data/vortex#0000](https://github.com/vortex-data/vortex/issues/0000)

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

Use code examples and diagrams where they might help.
Use code examples and diagrams where they might help, like this:

```rust
pub fn main() {
let x = f32::to_bits(100.0f32);
dbg!(x);
}
```

## Compatibility

Expand Down
94 changes: 94 additions & 0 deletions bun.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Empty file added completed/.keep
Empty file.
Loading