Skip to content

Commit 41ea72d

Browse files
committed
docs(lint): Fix markdown linting issues in archive and README
1 parent 90ff2be commit 41ea72d

2 files changed

Lines changed: 33 additions & 0 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,7 @@ Use `@export` annotations to expose variables to Godot's Inspector:
253253
```
254254

255255
**Inspector Features**:
256+
256257
- **Real-time Editing**: Modify values in Inspector during gameplay
257258
- **Automatic Clamping**: Range hints enforce min/max bounds
258259
- **Type Validation**: Compile-time checks for correct hint usage
@@ -280,6 +281,7 @@ fn take_damage(amount: f32) {
280281
```
281282

282283
**Signal Features**:
284+
283285
- **Type-Checked Parameters**: Compile-time validation of signal signatures
284286
- **Godot Integration**: Signals visible and connectable in Godot's Inspector
285287
- **Flexible Emission**: Use `emit("signal_name", params...)` in any function
@@ -625,6 +627,7 @@ See [docs/TESTING_GUIDE.md](docs/TESTING_GUIDE.md) for comprehensive testing doc
625627
### ✅ Implemented Features
626628

627629
**Core Language (Phases 1-3)**:
630+
628631
- [x] Lexer with full tokenization
629632
- [x] Parser with operator precedence and error recovery
630633
- [x] Type checker with static analysis (65+ error codes)
@@ -635,6 +638,7 @@ See [docs/TESTING_GUIDE.md](docs/TESTING_GUIDE.md) for comprehensive testing doc
635638
- [x] Global state persistence across frames
636639

637640
**Godot Integration (Phase 4-5)**:
641+
638642
- [x] Godot 4.x GDExtension integration via `gdext`
639643
- [x] `_ready()`, `_process()`, `_physics_process()` callbacks
640644
- [x] Self binding for node property access
@@ -646,6 +650,7 @@ See [docs/TESTING_GUIDE.md](docs/TESTING_GUIDE.md) for comprehensive testing doc
646650
- [x] Node query functions (`get_node()`, `get_parent()`, `find_child()`, `has_node()`)
647651

648652
**Quality & Testing**:
653+
649654
- [x] 843 tests passing (543 compiler + 110 runtime + 38 harness + 15 integration + 137 other)
650655
- [x] Comprehensive error messages with hints and suggestions
651656
- [x] VS Code extension with syntax highlighting, snippets, and IntelliSense

docs/archive/v0.0.4/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
3030
**Effort**: 3-4 days (under 5-7 day estimate)
3131

3232
**Deliverables**:
33+
3334
- Signal declaration syntax (`signal health_changed(old: i32, new: i32);`)
3435
- Signal emission (`emit_signal("health_changed", old, new);`)
3536
- Godot editor connection support
@@ -38,6 +39,7 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
3839
- 382 tests passing total
3940

4041
**Key Documents**:
42+
4143
- `PHASE_1_SIGNALS.md` - Complete implementation plan
4244
- `PHASE_1_STATUS_UPDATE.md` - Completion summary
4345
- `STEP_6_COMPLETION_REPORT.md` - Technical details
@@ -50,6 +52,7 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
5052
**Effort**: 1 day
5153

5254
**Deliverables**:
55+
5356
- `_input(event: InputEvent)` - User input handling
5457
- `_physics_process(delta: f32)` - Fixed timestep updates
5558
- `_enter_tree()` / `_exit_tree()` - Scene tree lifecycle
@@ -59,6 +62,7 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
5962
- 396 tests passing total
6063

6164
**Key Documents**:
65+
6266
- `PHASE_2_CHECKLIST.md` - Implementation checklist
6367
- `PHASE_2_PREP.md` - Preparation notes
6468

@@ -70,6 +74,7 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
7074
**Effort**: 1-2 days
7175

7276
**Deliverables**:
77+
7378
- `get_node(path: String) -> Node` - Retrieve nodes by path
7479
- `get_parent() -> Node` - Get parent node
7580
- `has_node(path: String) -> bool` - Check node existence
@@ -80,6 +85,7 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
8085
- 416 tests passing total
8186

8287
**Key Documents**:
88+
8389
- `PHASE_3_NODE_QUERIES.md` - Complete planning document
8490
- `NODE_INVALIDATION_RESEARCH.md` - Safety analysis for future work
8591
- Test harness in `crates/test_harness/` (shipped with release)
@@ -92,6 +98,7 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
9298
**Effort**: ~1 day
9399

94100
**Deliverables**:
101+
95102
- Color type (r, g, b, a fields)
96103
- Rect2 type (position, size fields with nested Vector2)
97104
- Transform2D type (position, rotation, scale fields)
@@ -102,6 +109,7 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
102109
- Godot binding conversions
103110

104111
**Key Documents**:
112+
105113
- `PHASE_4_COMPLETION_AND_GAPS.md` - Completion summary and gaps analysis
106114

107115
---
@@ -112,6 +120,7 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
112120
**Effort**: ~2.5 hours (MVP)
113121

114122
**Deliverables**:
123+
115124
- Struct literal syntax parsing (`Color { r: 1.0, g: 0.5, b: 0.0, a: 1.0 }`)
116125
- Type checker validation (missing fields, duplicate fields, wrong types)
117126
- Runtime evaluation with integer→float coercion
@@ -122,6 +131,7 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
122131
- 587 tests passing total
123132

124133
**Key Documents**:
134+
125135
- `STRUCT_LITERAL_SYNTAX_RESEARCH.md` - Syntax exploration
126136
- `STRUCT_LITERAL_IMPLEMENTATION_ANALYSIS.md` - Implementation strategy
127137
- `PHASE_4_5_EXECUTION_PLAN.md` - Execution plan
@@ -137,12 +147,14 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
137147
**Deliverables**:
138148

139149
#### Sub-Phase 1: Parser & AST (8 checkpoints, ~4 hours)
150+
140151
- `@export` annotation parsing
141152
- Property hint syntax: `range`, `file`, `enum`
142153
- 34 parser tests covering all hint types
143154
- Error recovery for invalid syntax
144155

145156
#### Sub-Phase 2: Type Checker & Validation (8 checkpoints, ~2 hours)
157+
146158
- Export eligibility validation (8 types supported)
147159
- Hint compatibility matrix
148160
- PropertyMetadata generation (hybrid architecture)
@@ -151,6 +163,7 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
151163
- Exact Godot hint_string formatting
152164

153165
#### Sub-Phase 3: Runtime & Inspector (8 checkpoints, ~6 hours)
166+
154167
- Per-instance property value storage
155168
- Property get/set with range clamping
156169
- Godot PropertyInfo generation
@@ -161,6 +174,7 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
161174
- 843 tests passing total
162175

163176
**Key Documents**:
177+
164178
- `PHASE_5_EXECUTION_PLAN.md` - Comprehensive execution plan (1,132 lines)
165179
- `EXPORT_ANNOTATION_RESEARCH.md` - Initial research
166180
- `PHASE_5_SUB_PHASE_1_COMPLETION.md` - Sub-Phase 1 completion report
@@ -211,6 +225,7 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
211225
**Discovery**: Breaking features into 8 structured checkpoints per sub-phase dramatically improved efficiency.
212226

213227
**Benefits**:
228+
214229
- Natural pause points every 15-30 minutes
215230
- Easy to resume work (clear next checkpoint)
216231
- Early bug detection (test after each checkpoint)
@@ -223,6 +238,7 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
223238
**Discovery**: Separating MVP implementation from robustness testing accelerated delivery.
224239

225240
**Benefits**:
241+
226242
- MVP completes faster (don't get stuck on edge cases)
227243
- MVP proves feasibility early
228244
- Robustness testing validates production-readiness
@@ -235,6 +251,7 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
235251
**Discovery**: Using static compile-time metadata + per-instance runtime values simplified Phase 5 implementation.
236252

237253
**Benefits**:
254+
238255
- Eliminated per-instance metadata duplication
239256
- Simplified Godot binding (direct static lookup)
240257
- Reduced runtime memory overhead
@@ -247,6 +264,7 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
247264
**Discovery**: Writing tests before implementation at each checkpoint caught bugs early.
248265

249266
**Benefits**:
267+
250268
- Tests serve as specification
251269
- Clear success criteria (test passes = checkpoint done)
252270
- Zero bugs found during robustness = high-quality MVP
@@ -259,11 +277,13 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
259277
**Discovery**: Allocating semantic ranges for feature families improved navigation and documentation.
260278

261279
**Benefits**:
280+
262281
- Easy to find related errors (all export errors start with E8)
263282
- Can reuse codes across similar types
264283
- Clear documentation patterns
265284

266285
**Application**:
286+
267287
- E70x: Struct literal errors
268288
- E80x: Export annotation errors
269289
- Future: E90x for arrays, E10xx for LSP, etc.
@@ -275,18 +295,21 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
275295
### Planning & Research
276296

277297
**High-Level Planning**:
298+
278299
- `ROADMAP.md` - Original v0.0.4 roadmap (deprecated, superseded by README.md)
279300
- `README.md` - Current v0.0.4 status and phase tracker
280301
- `QUICK_REFERENCE.md` - Quick reference for implementation patterns
281302

282303
**Phase-Specific Planning**:
304+
283305
- `PHASE_1_SIGNALS.md` - Phase 1 planning
284306
- `PHASE_2_CHECKLIST.md` / `PHASE_2_PREP.md` - Phase 2 planning
285307
- `PHASE_3_NODE_QUERIES.md` - Phase 3 complete planning
286308
- `PHASE_4_5_EXECUTION_PLAN.md` - Combined Phase 4 & 4.5 plan
287309
- `PHASE_5_EXECUTION_PLAN.md` - Comprehensive Phase 5 plan (1,132 lines)
288310

289311
**Research Documents**:
312+
290313
- `SIGNAL_RESEARCH.md` / `SIGNAL_RESEARCH_SUMMARY.md` - Signal system research
291314
- `NODE_INVALIDATION_RESEARCH.md` - Node safety research (future v0.0.5/v0.0.7)
292315
- `EXPORT_ANNOTATION_RESEARCH.md` - @export initial research
@@ -297,18 +320,21 @@ v0.0.4 is now **feature-complete and released**. All planning documents, researc
297320
### Completion Reports
298321

299322
**Phase Completion**:
323+
300324
- `STEP_6_COMPLETION_REPORT.md` - Phase 1 (signals) completion
301325
- `PHASE_4_COMPLETION_AND_GAPS.md` - Phase 4 completion and gap analysis
302326
- `PHASE_5_SUB_PHASE_1_COMPLETION.md` - Sub-Phase 1 (Parser) completion
303327
- `SUB_PHASE_2_COMPLETION_REPORT.md` - Sub-Phase 2 (Type Checker) completion
304328

305329
**Bundle Summaries** (Phase 5 Sub-Phase 3):
330+
306331
- `SESSION_SUMMARY_BUNDLES_5-6.md` - Bundles 5-6 (Inspector display + variant conversion)
307332
- `SESSION_SUMMARY_BUNDLES_7-8.md` - Bundles 7-8 (property hooks + runtime sync, COMPLETE)
308333
- `BUNDLE_6_COMPLETION_REPORT.md` - Bundle 6 details
309334
- `BUNDLE_7_COMPLETION_REPORT.md` - Bundle 7 details
310335

311336
**Testing & Integration**:
337+
312338
- `INTEGRATION_TESTS_REPORT.md` - Integration testing results (15 tests)
313339
- `INTEGRATION_TESTS_FIXES.md` - Bug fixes during integration testing
314340
- `TESTING_STRATEGY_PHASE5.md` - Phase 5 testing strategy
@@ -387,6 +413,7 @@ See `docs/planning/ROADMAP_MASTER.md` for the complete v0.0.5+ roadmap.
387413
## ✅ Archive Completeness
388414

389415
This archive contains:
416+
390417
- [x] All planning documents (50+)
391418
- [x] All completion reports
392419
- [x] All research documents
@@ -398,6 +425,7 @@ This archive contains:
398425
**Nothing was lost** - all information preserved for historical reference.
399426

400427
**Key information extracted** to main docs:
428+
401429
- ROADMAP_MASTER.md updated with v0.0.4 status
402430
- CHANGELOG.md updated with release notes
403431
- LEARNINGS.md updated with Phase 5 insights

0 commit comments

Comments
 (0)