Skip to content

Commit 5fa35a7

Browse files
author
Arnaud Riess
committed
docs: update references to SPECIFICATION.md in CLAUDE.md and PLAN.md
1 parent af16e02 commit 5fa35a7

2 files changed

Lines changed: 2 additions & 8 deletions

File tree

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ Each distinct `MAX_PAGES` and trait bound combination generates separate code. *
180180

181181
4. **LTO**: Link-time optimization eliminates unreachable monomorphized copies.
182182

183-
See SPECIFICATION.md §13.3 for complete strategies.
183+
See docs/SPECIFICATION.md §13.3 for complete strategies.
184184

185185
### Parallelization
186186
The transpilation pipeline can be parallelized. IR building and code generation are embarrassingly parallel (each function is independent). The transpiler should use `rayon` for parallel iteration when processing modules with 20+ functions. See SPECIFICATION.md §13.5 for implementation details and performance expectations.

PLAN.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,6 @@ Dependency chain: M1 → M2 → M3 → M4 → M5 (each milestone strictly depend
154154
These items were identified during pre-open-source code review and deferred for future milestones:
155155

156156
### Phase 4: Important Features and Spec Compliance
157-
- [ ] **IR type system cleanup**: Remove Rust-specific Display implementations from IR types
158-
- Files: [types.rs:40-50, 274-284](crates/herkos/src/ir/types.rs)
159-
- Move formatting logic to backend-specific code (e.g., `backend/safe.rs`)
160-
- Maintain backend-agnostic IR per SPECIFICATION.md §2
161157
- [ ] **Multi-value blocks**: Document limitation or implement support
162158
- Currently rejected at [builder.rs:713, 732, 753](crates/herkos/src/ir/builder.rs)
163159
- Add "Known Limitations" section to README.md and SPECIFICATION.md
@@ -175,9 +171,6 @@ These items were identified during pre-open-source code review and deferred for
175171
- Include corresponding `.wat` source files
176172

177173
### Phase 6: Technical Debt and Polish
178-
- [ ] **Refactor dead block pattern**: Add IR cleanup pass or document pattern
179-
- Dead blocks created after Return/Br waste block IDs [builder.rs:468-469](crates/herkos/src/ir/builder.rs#L468-L469)
180-
- Either add post-processing cleanup or add comments explaining necessity
181174
- [ ] **Store Wasm version and transpiler version in generated code**: Emit version as comment
182175
- TODO comment at [parser/mod.rs](crates/herkos/src/parser/mod.rs)
183176
- Add version field to `ParsedModule`
@@ -187,6 +180,7 @@ These items were identified during pre-open-source code review and deferred for
187180
- More informative transpilation failures
188181
- [ ] **Add badges to README**: CI status, crates.io version, license, docs.rs
189182
- Wait until after first crates.io publication
183+
- [ ] Search for "backwards compatibility" in the repo. Remove what's useless.
190184

191185
---
192186

0 commit comments

Comments
 (0)