@@ -7,14 +7,12 @@ Static site generator for Vortex RFC proposals built with Bun.
77```
88index.ts - Main build script and dev server
99styles.css - Site styling (light/dark themes)
10- proposed/ - RFC markdown files in proposed state
11- accepted/ - RFC markdown files in accepted state
12- completed/ - RFC markdown files in completed state
10+ rfcs/ - RFC markdown files (merged to develop = accepted)
1311dist/ - Build output (gitignored)
1412```
1513
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.
14+ RFC filenames follow the format ` NNNN-slug.md ` (e.g., ` 0027- patches-format .md` ).
15+ The RFC number must match the PR number used to propose it. No duplicate numbers allowed.
1816
1917## Commands
2018
@@ -26,29 +24,24 @@ bun run clean # Remove dist/
2624
2725## How the Build Works
2826
29- 1 . Scans ` proposed/ ` , ` accepted/ ` , ` completed/ ` for RFC files
27+ 1 . Scans ` rfcs/ ` for RFC markdown files
30282 . Parses RFC number from filename (e.g., ` 0002-foo.md ` → RFC 0002)
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
29+ 3 . Extracts title from first ` # ` heading
30+ 4 . Converts markdown to HTML using ` Bun.markdown.html() `
31+ 5 . Generates ` dist/index.html ` (table of contents)
32+ 6 . Generates ` dist/rfc/{number}.html ` for each RFC
3633
3734## Dev Server
3835
3936- Uses ` Bun.serve() ` to serve static files from ` dist/ `
40- - Watches ` proposed/ ` , ` accepted/ ` , ` completed/ ` , and ` styles.css ` for changes
37+ - Watches ` rfcs/ ` and ` styles.css ` for changes
4138- SSE endpoint at ` /__reload ` for live reload
4239
43- ## RFC States
40+ ## RFC Workflow
4441
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.
42+ 1 . Open a PR with a new file ` rfcs/NNNN-slug.md ` where NNNN matches the PR number
43+ 2 . PR builds a preview artifact for reviewers
44+ 3 . Merging the PR to ` develop ` accepts the RFC
5245
5346## Styling
5447
0 commit comments