Skip to content

Commit c5c229c

Browse files
fix: broken doc links (#4)
* fix: dead links * removed examples dir
1 parent 2aae854 commit c5c229c

File tree

7 files changed

+16
-311
lines changed

7 files changed

+16
-311
lines changed

ROADMAP.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@
1818
| v0.3.0 || [Global State](#global-state) |
1919
| v0.4.0 || [Animation & Transitions](#animation--transitions) |
2020
| v0.5.0 | | [History API Routing Plugin](#history-api-routing-plugin) |
21+
| | | [Navigation & History Management](#navigation--history-management) |
2122
| || [Refactor](#evaluator--binder-hardening) |
22-
| | | [Persistence & Offline](#persistence--offline) |
23-
| | | [Background Requests & Reactive Polling](#background-requests--reactive-polling) |
24-
| v0.6.0 | | [Navigation & History Management](#navigation--history-management) |
23+
| v0.6.0 | | [Background Requests & Reactive Polling](#background-requests--reactive-polling) |
2524
| v0.7.0 | | [Streaming & Patch Engine](#streaming--patch-engine) |
2625
| v0.8.0 | | PWA Capabilities |
26+
| | | [Persistence & Offline](#persistence--offline) |
2727
| v0.9.0 | | [Inspector & Developer Tools](#inspector--developer-tools) |
2828
| v1.0.0 | | [Stable Release](#stable-release) |
2929

@@ -72,9 +72,6 @@ _NOTE_: `data-x-*` is now `data-volt-*`
7272
**Goal:** Use JavaScript Proxies to improve reactivity ergonomics and automatic dependency tracking.
7373
**Outcome:** More intuitive API with automatic dependency tracking and optional deep reactivity for objects/arrays.
7474
**Summary:** Proxy-driven automatic dependency tracking, deep reactive() objects, reactive arrays, lazy signal creation, and debugging utilities improve reactivity ergonomics and performance.
75-
**Notes:**
76-
- Separate reactive() function for objects/arrays to gives users choice
77-
- Keep .get()/.set() - explicitness is valuable for understanding reactivity (include in docs)
7875

7976
### Reactive Attributes & Event Modifiers
8077

@@ -189,7 +186,7 @@ _NOTE_: `data-x-*` is now `data-volt-*`
189186
- Full API reference with examples
190187
- Create generator in `@voltx/cli` package
191188
- Finalized plugin registry and CLI (`volt plugins list/init`)
192-
- Versioned documentation (stormlightlabs.github.io/volt)
189+
- Versioned documentation (<https://stormlightlabs.github.io/volt>)
193190
- Announcement post and release notes
194191
- Community contribution guide & governance doc
195192

@@ -199,6 +196,8 @@ _NOTE_: `data-x-*` is now `data-volt-*`
199196

200197
All expression evaluation now flows through a cached `new Function` compiler guarded by a hardened scope proxy, with the binder slimmed into a directive registry so plugins self-register while tests verify the sandboxed error surfaces.
201198

199+
### Naming
200+
202201
## Examples
203202

204203
Many of these are ideas, not planned to be implemented
@@ -235,7 +234,7 @@ These will live in an example repo.
235234

236235
- Authentication Flows - Login, signup, password reset, email verification (Go, Python, Rust, Node)
237236
- File Upload with Progress - Chunked uploads, progress bars, validation (Go, Python, Rust, Node)
238-
- Search with Server-Side Filtering - Debounced search, paginated results (Go, Python,Rust, Node)
237+
- Search with Server-Side Filtering - Debounced search, paginated results (Go, Python, Rust, Node)
239238

240239
### Desktop Apps
241240

docs/installation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ For SSR applications, use the `hydrate()` function instead of `charge()` to pres
139139
</script>
140140
```
141141

142-
See the [Server-Side Rendering & Lifecycle](./lifecycle) documentation for complete SSR patterns and hydration strategies.
142+
See the [Server-Side Rendering & Lifecycle](./usage/lifecycle) documentation for complete SSR patterns and hydration strategies.
143143

144144
## Plugin Setup
145145

@@ -178,6 +178,6 @@ VoltX.js requires modern browsers with support for:
178178
## Next Up
179179

180180
- Read the [Framework Overview](./overview) to understand core concepts
181-
- Learn about [State Management](./state) with signals and computed values
182-
- Explore available [Bindings](./bindings) for DOM manipulation
183-
- Check out [Expression Evaluation](./expressions) for template syntax
181+
- Learn about [State Management](./usage/state) with signals and computed values
182+
- Explore available [Bindings](./usage/bindings) for DOM manipulation
183+
- Check out [Expression Evaluation](./usage/expressions) for template syntax

docs/usage/counter.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ This counter demonstrates core VoltX.js concepts:
282282

283283
## Further Reading
284284

285-
- [State Management](../state) for advanced signal patterns
286-
- [Bindings](../bindings) for complete binding reference
287-
- [Expressions](../expressions) for template syntax details
288-
- [Lifecycle](../lifecycle) for SSR and hydration
285+
- [State Management](./state) for advanced signal patterns
286+
- [Bindings](./bindings) for complete binding reference
287+
- [Expressions](./expressions) for template syntax details
288+
- [Lifecycle](./lifecycle) for SSR and hydration

docs/usage/state.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Common uses include:
3737
- Logging or analytics
3838
- Coordinating multiple signals
3939

40-
For asynchronous operations, use `asyncEffect()` (see [asyncEffect](./usage/async-effect)) which handles cleanup of pending operations when dependencies change or the effect is disposed.
40+
For asynchronous operations, use `asyncEffect()` (see [asyncEffect](./async-effect.md)) which handles cleanup of pending operations when dependencies change or the effect is disposed.
4141

4242
## Declarative State
4343

examples/TODO.md

Lines changed: 0 additions & 61 deletions
This file was deleted.

examples/counter/index.html

Lines changed: 0 additions & 89 deletions
This file was deleted.

examples/form-validation/index.html

Lines changed: 0 additions & 144 deletions
This file was deleted.

0 commit comments

Comments
 (0)