Skip to content

Commit 97c247a

Browse files
committed
docs: move framework details to docs/overview
1 parent 70f8077 commit 97c247a

File tree

2 files changed

+31
-46
lines changed

2 files changed

+31
-46
lines changed

README.md

Lines changed: 7 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -11,63 +11,24 @@
1111
1212
Volt is a monorepo centered around the VoltX.js runtime—a lightweight, declarative alternative to component-centric UI frameworks. The repo also ships the Volt CLI and the documentation site that demonstrates and explains the runtime.
1313

14-
## Philosophy/Goals
14+
## Local Development
1515

16-
- Behavior is declared via `data-volt-*` attributes.
17-
- HTML drives the UI, not components.
18-
- Core under **20 KB gzipped**, zero dependencies.
19-
- Signals update the DOM directly without a virtual DOM.
20-
- Native Server-Sent Events (SSE) and WebSocket patch updates.
21-
- No reactivity scheduler, no VDOM diffing.
22-
- Extend behavior declaratively (persist, scroll, animate, etc.).
23-
- Progressive enhancement, i.e. works with static HTML out of the box.
24-
25-
### Values
26-
27-
- Never exceed 15 KB for the core runtime.
28-
- No custom build systems — work with any backend.
29-
- All source in TypeScript, no magical DSLs.
30-
- Every feature ships with a test harness.
31-
32-
## Concepts
33-
34-
| Concept | Description |
35-
| -------- | ------------------------------------------------------------------------------------------------- |
36-
| Signals | Reactive primitives that automatically update DOM bindings when changed. |
37-
| Bindings | `data-volt-text`, `data-volt-html`, `data-volt-class` connect attributes or text to expressions. |
38-
| Actions | `data-volt-on-click`, `data-volt-on-input`, etc. attach event handlers declaratively. |
39-
| Streams | `data-volt-stream="/events"` listens for SSE or WebSocket updates and applies JSON patches. |
40-
| Plugins | Modular extensions (`data-volt-persist`, `data-volt-surge`, `data-volt-shift`, etc.) to enhance the core. |
41-
42-
## VoltX.css
43-
44-
VoltX ships with an optional classless CSS framework inspired by Pico CSS and Tufte CSS. It provides beautiful, semantic styling for HTML elements without requiring any CSS classes—just write semantic markup and it looks great out of the box.
45-
46-
Features include typography with modular scale, Tufte-style sidenotes, styled form elements, dialogs, accordions, tooltips, tables, and more. See the framework's [README](./lib/README.md#voltxcss) for installation and usage details.
47-
48-
Here are some highlights
49-
50-
![VoltX Typography](./docs/images/voltx-css_typography.png)
51-
52-
![VoltX Structured Content](./docs/images/voltx-css_structured-content.png)
53-
54-
![VoltX Components](./docs/images/voltx-css_components.png)
55-
56-
## Packages
16+
### Packages
5717

5818
```sh
5919
volt/
6020
├── lib/ VoltX.js runtime published to npm (`voltx.js`) and JSR (`@voltx/core`)
61-
├── dev/ Volt CLI and local tooling
21+
├── dev/ VoltX dev CLI and local tooling
22+
├── cli/ Project scaffolding and management CLI (`create-voltx`)
6223
└── docs/ VitePress documentation site
6324
```
6425

65-
## Getting Started
26+
### Getting Started
6627

6728
- Runtime usage: see [`lib/README.md`](./lib/README.md) for installation guides and quick-start examples.
6829
- Local development: `pnpm install` then `pnpm --filter lib dev` run package-specific scripts (`build`, `test`, etc.).
6930
- Review [contribution](./CONTRIBUTING.md) guidelines
70-
- Documentation: `pnpm --filter docs docs:dev` launches the VitePress site.
31+
- Documentation: `pnpm docs:dev` launches the VitePress site.
7132

7233
### Working on New Features
7334

@@ -94,4 +55,4 @@ Docs are the source of truth but take advantage of this environment. When develo
9455

9556
## License
9657

97-
MIT License © 2025 Stormlight Labs
58+
[MIT License](./lib/LICENSE) © 2025 Stormlight Labs

docs/overview.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,30 @@ It combines HTML-driven behavior via `data-volt-*` attributes with signal-based
4141
- TypeScript source
4242
- Every feature tested
4343

44+
## Concepts
45+
46+
| Concept | Description |
47+
| -------- | --------------------------------------------------------------------------------------------------------- |
48+
| Signals | Reactive primitives that automatically update DOM bindings when changed. |
49+
| Bindings | `data-volt-text`, `data-volt-html`, `data-volt-class` connect attributes or text to expressions. |
50+
| Actions | `data-volt-on-click`, `data-volt-on-input`, etc. attach event handlers declaratively. |
51+
| Streams | `data-volt-stream="/events"` listens for SSE or WebSocket updates and applies JSON patches. |
52+
| Plugins | Modular extensions (`data-volt-persist`, `data-volt-surge`, `data-volt-shift`, etc.) to enhance the core. |
53+
54+
## VoltX.css
55+
56+
VoltX ships with an optional classless CSS framework inspired by Pico CSS and Tufte CSS. It provides beautiful, semantic styling for HTML elements without requiring any CSS classes—just write semantic markup and it looks great out of the box.
57+
58+
Features include typography with modular scale, Tufte-style sidenotes, styled form elements, dialogs, accordions, tooltips, tables, and more. See the framework's [README](../lib/README.md#voltxcss) for installation and usage details.
59+
60+
Here are some highlights
61+
62+
![VoltX Typography](./images/voltx-css_typography.png)
63+
64+
![VoltX Structured Content](./images/voltx-css_structured-content.png)
65+
66+
![VoltX Components](./images/voltx-css_components.png)
67+
4468
## Browser Support
4569

4670
Modern browsers (Chrome 90+, Firefox 88+, Safari 14+) with support for:

0 commit comments

Comments
 (0)