Skip to content

Commit 24a02f0

Browse files
docs: update for vnext. (#114)
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent e252217 commit 24a02f0

3 files changed

Lines changed: 68 additions & 46 deletions

File tree

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,29 +9,39 @@ CDN-first UI component workbench for rapid prototyping with [`@knighted/jsx`](ht
99

1010
## What it is
1111

12-
`@knighted/develop` is a browser-native UI component workbench that demonstrates
13-
modern component authoring without a local bundler-first inner loop.
12+
`@knighted/develop` is a browser-native component editor/workbench for fast
13+
UI iteration without a local bundler-first inner loop.
1414

1515
The app is designed to showcase two libraries:
1616

1717
- [`@knighted/jsx`](https://github.com/knightedcodemonkey/jsx) for DOM-first and React-mode JSX authoring
1818
- [`@knighted/css`](https://github.com/knightedcodemonkey/css) for in-browser CSS compilation workflows
1919

2020
Dependencies are delivered over CDN ESM with on-demand loading by mode, so the
21-
browser acts as the runtime host for render, lint, and typecheck flows.
21+
browser acts as the runtime host for editing, render, lint, and typecheck flows.
2222

2323
## Core capabilities
2424

2525
`@knighted/develop` lets you:
2626

27-
- write component code in the browser
28-
- manage dynamic workspace tabs with add, rename, remove, and entry-role protection
27+
- write component code in dynamic editor tabs in the browser
28+
- add, rename, and remove tabs with entry-role protection for required tabs
29+
- keep per-tab dirty/synced state while iterating across files
2930
- switch render mode between DOM and React
3031
- switch style mode between native CSS, CSS Modules, Less, and Sass
3132
- run in-browser lint and type diagnostics
3233
- open diagnostics in a shared drawer and jump to source locations
33-
- toggle ShadowRoot preview isolation while iterating
34-
- switch layout and theme while preserving fast feedback loops
34+
- use iframe-isolated preview style encapsulation while iterating
35+
- connect a GitHub repository and run Open PR / Push Commit workflows
36+
- use AI chat with tab-aware proposals and apply/undo controls
37+
- switch theme and collapse the preview panel while preserving fast feedback loops
38+
39+
## Why this shape
40+
41+
The app started as a focused compile-and-preview loop and has grown into a
42+
more complete browser-native editor surface. The goal is still fast
43+
experimentation, now with practical multi-file editing and repository workflows
44+
in the same UI.
3545

3646
## Try it
3747

docs/article.md

Lines changed: 51 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,90 @@
1-
# Forget The Build Step: A Browser-Native Workbench For JSX + CSS
1+
# Forget The Build Step: A Browser-Native Editor For JSX + CSS
22

3-
Frontend tooling has become incredibly capable.
3+
Frontend tooling is incredibly capable.
44

5-
It has also become very heavy.
5+
It is also often front-loaded.
66

7-
For many UI experiments, the first thing you do is not write code. You install dependencies, run a dev server, wait for transforms, and only then start iterating.
7+
For many UI ideas, the first thing you do is not write code. You install,
8+
configure, and wait. The creative loop starts late.
89

9-
I wanted to try a different baseline:
10+
[@knighted/develop](https://github.com/knightedcodemonkey/develop) is built
11+
for a different default: fast prototyping from anywhere you can open a browser.
1012

11-
What if the browser is the dev environment?
12-
13-
That idea became [@knighted/develop](https://github.com/knightedcodemonkey/develop).
14-
15-
It is a lightweight in-browser UI component workbench built to showcase [@knighted/jsx](https://github.com/knightedcodemonkey/jsx) and [@knighted/css](https://github.com/knightedcodemonkey/css), with dependencies delivered over CDN ESM instead of requiring a local build step in the inner loop.
13+
It is a browser-native editor/workbench for
14+
[@knighted/jsx](https://github.com/knightedcodemonkey/jsx) and
15+
[@knighted/css](https://github.com/knightedcodemonkey/css), delivered through
16+
CDN ESM with mode-aware loading.
1617

1718
## The Loop, In Practice
1819

19-
Open a page, write JSX and styles, switch rendering/style modes, run lint/typecheck, and see results immediately.
20+
Open the app, edit multiple files in dynamic tabs, switch render/style modes,
21+
run lint/type diagnostics, and preview instantly.
2022

21-
No local bundler needed for that loop.
23+
No local bundler is required for that inner loop.
2224

23-
## What Makes It Fun To Use
24-
25-
The app is intentionally practical, not just a demo shell:
25+
## What The App Gives You
2626

27+
- Dynamic tabbed editing (add, rename, remove, and protect required entry tabs)
2728
- Render mode switch: DOM or React
2829
- Style mode switch: CSS, CSS Modules, Less, Sass
29-
- Live preview with ShadowRoot toggle
30-
- In-browser lint and type diagnostics
31-
- Diagnostics drawer with jump-to-line navigation (mouse or keyboard)
30+
- Live preview with iframe-isolated style encapsulation
31+
- In-browser lint and type diagnostics with jump-to-source navigation
32+
- GitHub-connected workflows for Open PR and Push Commit
33+
- AI chat with tab-aware edit proposals and explicit apply/undo controls
3234

33-
So it is not only "can this compile?" It is closer to "can I actually iterate on a component quickly?"
35+
This is not only "can this compile?" It is about shipping the whole iteration
36+
loop in one place: edit, validate, preview, sync, and refine.
3437

3538
## Why `@knighted/jsx` + `@knighted/css` Matter Here
3639

37-
`@knighted/develop` is primarily a showcase app.
38-
39-
It demonstrates how these libraries behave in a real authoring environment:
40+
The app demonstrates both libraries in realistic authoring conditions:
4041

41-
- `@knighted/jsx` gives you a direct path from JSX to rendered output, including DOM-first workflows.
42-
- `@knighted/css` handles modern style pipelines in-browser, including Modules/Less/Sass.
42+
- `@knighted/jsx` provides a direct path from JSX to rendered output,
43+
including DOM-first workflows.
44+
- `@knighted/css` handles modern browser-side style compilation,
45+
including Modules/Less/Sass modes.
4346

44-
Using both together in one interface makes the bigger point obvious: modern browsers can do much more of the compile/authoring cycle than we usually ask them to.
47+
Together they show how much of the authoring cycle modern browsers can run
48+
directly.
4549

46-
## "Compiler-as-a-Service" Without A Backend Build Farm
50+
## "Compiler-as-a-Service" Without A Build Farm
4751

4852
In this project, Compiler-as-a-Service means:
4953

50-
- CDN handles module and WASM delivery.
51-
- The browser tab does the actual compile, lint, typecheck, and render work.
54+
- CDN delivers modules and WASM artifacts.
55+
- The browser session performs compile, lint, typecheck, render, and editor
56+
interactions locally.
5257

53-
It is service-oriented distribution, local execution.
58+
It is service-oriented distribution with local execution.
5459

55-
And because loading is mode-aware, you only pay for what you use. If you never touch Sass, you never load Sass.
60+
Mode-aware loading keeps costs aligned to usage: if you do not use Sass,
61+
Sass does not load.
5662

5763
## Why This Matters
5864

59-
This is not trying to replace production pipelines.
65+
This does not replace production pipelines.
6066

61-
It is about lowering the cost of exploration.
67+
It lowers the cost of exploration while preserving enough workflow surface to
68+
be useful for real component work.
6269

63-
When the setup tax drops, you try more ideas. When feedback is instant, you discover faster. And when the browser is the platform, sharing a repro can be as easy as sharing a URL.
70+
When setup friction drops, teams try more ideas. When feedback is immediate,
71+
they converge faster. When browser-native workspaces can sync to GitHub and
72+
carry chat-assisted edit proposals, collaboration is lighter too.
6473

65-
For prototyping and component iteration, that is a meaningful shift.
74+
For prototyping and component development, that is a meaningful shift.
6675

6776
## Try It
6877

6978
- Live workbench: https://knightedcodemonkey.github.io/develop/
7079
- Source: https://github.com/knightedcodemonkey/develop
7180

72-
If you are curious, start by toggling:
81+
If you want a fast product tour, try this sequence:
7382

74-
1. DOM -> React render mode
75-
2. CSS -> Modules -> Less -> Sass style mode
76-
3. ShadowRoot on/off
83+
1. Add a new tab, rename it, and make an edit.
84+
2. Toggle DOM -> React render mode.
85+
3. Toggle CSS -> Modules -> Less -> Sass style mode.
86+
4. Open diagnostics and jump to a reported line.
87+
5. Connect BYOT (Bring Your Own Token) by adding a GitHub personal access token, then run Open PR / Push Commit.
88+
6. Ask chat for a targeted tab update, then apply it.
7789

78-
That sequence tells the story better than any architecture diagram.
90+
That flow tells the product story better than any architecture diagram.

docs/media/develop-ide-flow.gif

3 MB
Loading

0 commit comments

Comments
 (0)