Skip to content

Commit 98ed436

Browse files
authored
docs: update docs after first alpha release (#49)
1 parent ed15f38 commit 98ed436

3 files changed

Lines changed: 58 additions & 38 deletions

File tree

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,36 @@ The current repository proves the core shape:
3434

3535
It is not production-ready yet. The goal right now is to keep the foundation small, inspectable, and hard to fake.
3636

37+
## Install
38+
39+
Intent is available as experimental alpha packages on npm:
40+
41+
```sh
42+
pnpm add @intent-framework/core@alpha @intent-framework/dom@alpha @intent-framework/router@alpha @intent-framework/testing@alpha
43+
```
44+
45+
```sh
46+
npm install @intent-framework/core@alpha @intent-framework/dom@alpha @intent-framework/router@alpha @intent-framework/testing@alpha
47+
```
48+
49+
```txt
50+
First public alpha: v0.1.0-alpha.0
51+
GitHub Release: https://github.com/intent-framework/intent/releases/tag/v0.1.0-alpha.0
52+
```
53+
54+
Published packages:
55+
56+
| Package | npm |
57+
|---------|-----|
58+
| `@intent-framework/core` | Platformless semantic graph and runtime |
59+
| `@intent-framework/dom` | DOM materializer for screens and router |
60+
| `@intent-framework/router` | Typed route definitions and navigation |
61+
| `@intent-framework/testing` | Semantic test harness |
62+
63+
`@intent-framework/server` remains private and unpublished.
64+
65+
This is experimental alpha software. APIs are subject to change. Not recommended for production use.
66+
3767
## Why Intent exists
3868

3969
Modern app code often scatters product meaning across UI components, route files, data hooks, form handlers, test selectors, and backend endpoints.

docs/MVP-Checkpoint.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ It now has:
5050
- Complex nested routing/layouts.
5151
- Form arrays or complex forms.
5252
- Styling/theming story.
53-
- Package publishing flow.
53+
- Production package publishing flow (first alpha published, need to validate end-to-end).
5454

5555
## Implemented packages
5656

@@ -104,7 +104,7 @@ See also the README [Current limitations](../README.md#current-limitations).
104104
- No backend persistence yet.
105105
- No real resource cache policy yet.
106106
- No DevTools package yet.
107-
- No package publishing flow yet.
107+
- Package publishing flow is set up (Changesets + manual publish workflow). First alpha published.
108108
- Demo side panels use manual DOM.
109109
- Demo diagnostics panel uses `MutationObserver`.
110110
- Demo data is in memory only.

docs/Release-Readiness.md

Lines changed: 26 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,17 @@
22

33
## Status
44

5-
Intent is in early experimental development. No packages have been published to npm. No GitHub Releases have been created.
5+
Intent's first public alpha has been published.
66

7-
The repository has five workspace packages under `packages/*`. The four publishable packages are at version `0.1.0-alpha.0`. The private server package remains at `0.1.0`. All use `workspace:*` dependency references. The codebase is functional and validated by CI. Changesets is installed and configured. Release workflows exist for automated version PRs and manual alpha publishing.
7+
GitHub Release: [v0.1.0-alpha.0](https://github.com/intent-framework/intent/releases/tag/v0.1.0-alpha.0)
88

9-
Four packages are intended for first-alpha publishing. `packages/server` is a private workspace package for now.
9+
Four packages are published to npm under the `@intent-framework/*` scope. The server package `@intent-framework/server` remains private and unpublished.
1010

11-
## Intended publishable packages
11+
Changesets is installed and configured. Release workflows exist for automated version PRs and manual alpha publishing.
1212

13-
The first alpha will publish four packages:
13+
## Published packages
14+
15+
The following packages are published to npm:
1416

1517
| Package | npm name | Purpose |
1618
|---|---|---|
@@ -243,48 +245,36 @@ Do not manually create GitHub Releases.
243245
- [x] Release workflows added:
244246
- Version Packages PR workflow (push-to-main)
245247
- Manual Publish Alpha workflow (manual dispatch only)
246-
- [ ] NPM_TOKEN secret added to GitHub repository secrets
247-
- [ ] Publish first alpha via manual Publish Alpha workflow
248-
- [ ] Optionally create a GitHub Release manually after npm publish
249-
250-
## Current blockers
251-
252-
- repository fields: present
253-
- GitHub repository home: `intent-framework/intent`
254-
- Changesets: installed and configured
255-
- Release workflows: version-packages.yml (automated version PRs) and publish-alpha.yml (manual publish) are added
256-
- Remaining first-alpha blocker: add `NPM_TOKEN` secret, then manually run Publish Alpha
248+
- [x] NPM_TOKEN secret added to GitHub repository secrets
249+
- [x] Publish first alpha via manual Publish Alpha workflow
250+
- [x] GitHub Release v0.1.0-alpha.0 created
257251

258-
## Future server-package decisions
252+
## Post-release verification
259253

260-
- Server maturity is no longer a first-alpha publishing blocker because server is private
261-
- When the server API matures, the package can be made public and published as a separate decision
254+
Published packages:
262255

263-
## Do not do yet
256+
- `@intent-framework/core@0.1.0-alpha.0`
257+
- `@intent-framework/dom@0.1.0-alpha.0`
258+
- `@intent-framework/router@0.1.0-alpha.0`
259+
- `@intent-framework/testing@0.1.0-alpha.0`
264260

265-
- Do not publish any package to npm until the manual Publish Alpha workflow is triggered.
266-
- Do not create a GitHub Release yet. The current manual Publish Alpha workflow publishes npm packages only. GitHub Releases are not automated yet.
267-
- Do not change runtime or public APIs.
268-
- Do not add new dependencies unless required for a specific task.
261+
Verified:
269262

270-
## Required secret: NPM_TOKEN
263+
- npm install smoke test passed
264+
- `alpha` dist-tag points to `0.1.0-alpha.0`
265+
- `latest` dist-tag currently points to `0.1.0-alpha.0` because this is the only published version
271266

272-
Before running the Publish Alpha workflow, a GitHub Actions secret must be added:
267+
When stable releases exist, `latest` should point to stable releases and `alpha` should point to prereleases.
273268

274-
| Secret | Purpose |
275-
|---|---|
276-
| `NPM_TOKEN` | npm access token with publish permission for `@intent-framework/*` packages |
269+
## Server package
277270

278-
The token must:
279-
- Have **publish** permission for the `@intent-framework` npm organization
280-
- Be stored as a GitHub Actions secret (not in the repository)
281-
- Be configured in the `npm` GitHub environment used by the Publish Alpha workflow
271+
`@intent-framework/server` remains a private workspace package until the server API matures. When the server API matures, the package can be made public and published as a separate decision.
282272

283-
Do not commit the token value to the repository.
273+
## NPM_TOKEN
284274

285-
### Future improvement: trusted publishing
275+
`NPM_TOKEN` is required for manual publishing. Prefer environment-scoped GitHub secret under the `npm` environment. Use least privilege.
286276

287-
Migrate npm publishing to trusted publishing / OIDC once the initial package publishing flow is stable.
277+
Future improvement: migrate npm publishing to trusted publishing / OIDC once the initial package publishing flow is stable.
288278

289279
## Pack check command
290280

0 commit comments

Comments
 (0)