@aotter/mantle 0.1.3-alpha.6 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/README.md +1 -1
  2. package/dist/cli/main.d.ts +1 -1
  3. package/dist/cli/main.d.ts.map +1 -1
  4. package/dist/cli/main.js +3 -1
  5. package/dist/cli/main.js.map +1 -1
  6. package/dist/cli/skills.js +1 -1
  7. package/dist/cli/skills.js.map +1 -1
  8. package/docs/agent-prompts.md +6 -5
  9. package/docs/consumer-onboarding-audit.md +65 -0
  10. package/docs/handbook/cloudflare/authentication.md +16 -0
  11. package/docs/handbook/concepts/mcp-and-agents.md +1 -1
  12. package/docs/handbook/concepts/runtime-and-adapters.md +1 -1
  13. package/docs/handbook/concepts/views.md +8 -7
  14. package/docs/handbook/guides/admin-ui.md +135 -0
  15. package/docs/handbook/guides/agent-setup.md +96 -0
  16. package/docs/handbook/guides/typed-queries.md +161 -0
  17. package/docs/handbook/navigation.json +24 -14
  18. package/docs/handbook/reference/features.md +55 -0
  19. package/docs/handbook/reference/manifest.md +3 -1
  20. package/docs/handbook/reference/schema.md +1 -1
  21. package/docs/handbook/reference/surface.md +1 -1
  22. package/docs/handbook/reference/view.md +4 -2
  23. package/docs/handbook/releases/index.md +45 -1
  24. package/docs/handbook/start/overview.md +52 -0
  25. package/docs/handbook/start/project-and-cli.md +2 -2
  26. package/docs/handbook/start/quickstart-worker.md +8 -3
  27. package/docs/spec-only-host-adoption.md +1 -1
  28. package/package.json +17 -17
  29. package/skills/README.md +5 -1
  30. package/skills/develop/SKILL.md +19 -2
  31. package/skills/install/SKILL.md +23 -3
  32. package/skills/plugin/SKILL.md +17 -5
  33. package/skills/theme/SKILL.md +8 -1
  34. package/skills/update/SKILL.md +7 -2
@@ -16,6 +16,23 @@ provider configuration. There is no Starter/type picker or `mantle create`.
16
16
  Do not use the SDK checkout as the application, copy an old Starter tree, or
17
17
  turn `generate` into implicit scaffolding.
18
18
 
19
+ ## Locate the version-matched instructions
20
+
21
+ `npx skills add aotter/mantle --skill install` installs this brief, not the SDK,
22
+ a project, or the handbook. Read the path printed by the installer (Codex's
23
+ project-local path is `.agents/skills/install/SKILL.md`); `metadata.sourcePath`
24
+ is repository provenance, not a consumer path. A repository install follows
25
+ the selected Git ref and does not pin an npm release.
26
+
27
+ After selecting the host and exact version, install `@aotter/mantle` locally
28
+ with the selected optional packages. All `docs/...` paths below then mean
29
+ `node_modules/@aotter/mantle/docs/...`; package skills are under
30
+ `node_modules/@aotter/mantle/skills/`. Read that package's
31
+ `skills/install/SKILL.md` before authoring: it supersedes this bootstrap copy.
32
+ If the user requested a prerelease, resolve that channel explicitly; `latest`
33
+ need not contain prerelease features. Never mix versioned npm code with branch
34
+ docs. No local CLI exists until the package is installed.
35
+
19
36
  ## New application
20
37
 
21
38
  1. Determine the actual host and required surfaces from the request. Reuse an
@@ -30,8 +47,9 @@ turn `generate` into implicit scaffolding.
30
47
  version. Install only the adapter/optional packages the application needs.
31
48
  If a global scope registry overrides public npmjs, use a project-owned
32
49
  `.npmrc` with `@aotter:registry=https://registry.npmjs.org/`.
33
- 3. Interview the human for host and required surfaces. Do not assume Admin,
34
- public HTML or Cloudflare. Scale:
50
+ 3. Use the host and surfaces already established in step 1; ask only for
51
+ information still missing. Read `docs/handbook/start/overview.md` and
52
+ `docs/handbook/reference/features.md`, then select the matching path:
35
53
  - Spec + generate / embed Runtime — `docs/handbook/start/project-and-cli.md`.
36
54
  - Adapter without Admin — `docs/examples/host-minimal-worker/`.
37
55
  - Opt-in Admin / Dev UI — only when a human needs a console: interview
@@ -108,7 +126,9 @@ a bundle comparison command.
108
126
 
109
127
  ## Ship and report
110
128
 
111
- When deployment is requested, follow the installed provision skill and the
129
+ When deployment is requested, read
130
+ `node_modules/@aotter/mantle/skills/provision/SKILL.md` (not projected by
131
+ `mantle skills`) and follow that version-matched skill and the
112
132
  observed host configuration. Legacy Landing remains a pre-stable product; it
113
133
  is not a launch dependency for new Core projects.
114
134
 
@@ -50,11 +50,17 @@ stop and ask for the recipe instead of guessing.
50
50
  ## First Read
51
51
 
52
52
  1. `package.json` for Mantle version and adapter package.
53
- 2. `manifests/site.yaml` for current atom names and route/tool collisions.
54
- 3. `src/mantle/config.ts` and `src/mantle/handlers/` for registered handlers, templates, and optional ports. Older projects may use `src/mantleConfig.ts`.
53
+ 2. The manifest directory selected by project scripts for current atom names
54
+ and route/tool collisions.
55
+ 3. The actual host entry and its handler, template and port registrations;
56
+ `src/mantle/config.ts` and `src/mantle/handlers/` are conventions, not required paths.
55
57
  4. `.mantle/plugins.json` and `.mantle/plugins.lock.json` if present.
56
58
  5. `.mantle/launch-state.json` only as context, not as plugin authority.
57
59
 
60
+ Read version-matched contracts under `node_modules/@aotter/mantle/docs/`,
61
+ starting with `handbook/reference/features.md`. Plugin recipes cannot override
62
+ the installed grammar.
63
+
58
64
  ## Plan First
59
65
 
60
66
  Before applying any plugin, produce a plan:
@@ -100,14 +106,20 @@ and report the dependency instead of deleting through it.
100
106
 
101
107
  ## Verify
102
108
 
109
+ Use the project's validation and typecheck scripts when present. Regenerate
110
+ the plan after manifest changes before probing the running host:
111
+
103
112
  ```bash
104
- pnpm validate
105
- pnpm typecheck
113
+ pnpm exec mantle validate
114
+ pnpm exec mantle generate
115
+ pnpm exec mantle generate --check
116
+ # Run the project's TypeScript check and restart its local server.
106
117
  ```
107
118
 
108
119
  Then verify the plugin's declared surfaces:
109
120
 
110
- - `GET /api/views/<name>` for View reads;
121
+ - public Views via `GET /api/views/<name>`, staff Views via authenticated
122
+ Admin/staff MCP, and internal Views through the host binding;
111
123
  - HTTP Trigger path for public writes;
112
124
  - Staff/Public MCP `tools/list` for MCP Trigger or Schema-derived tools;
113
125
  - adapter resource presence when the plugin requires optional ports.
@@ -13,13 +13,20 @@ metadata:
13
13
  Theme work is project-owned source editing. Use the actual frontend and its
14
14
  tokens/recipes; Core does not install a default home page or UI tree.
15
15
 
16
+ For requests to change the Admin console, first read installed
17
+ `node_modules/@aotter/mantle/docs/handbook/guides/admin-ui.md` and use the
18
+ develop skill. Labels, widgets, list columns, filters and actions may already
19
+ be manifest-driven. Visitor CSS does not style the prebuilt Admin SPA, and
20
+ `uiSchema` does not accept arbitrary CSS, components or layout keys.
21
+
16
22
  ## First Read
17
23
 
18
24
  1. `.mantle/handoff.md` and `.mantle/recipes/` if present.
19
25
  2. `styles/`, `components/`, `src/web/`, `src/theme*`, and UI-library config
20
26
  if present.
21
27
  3. A vendored UI palette's manifest and license, if present.
22
- 4. `manifests/site.yaml` to understand which content shape drives the public UI.
28
+ 4. The manifest directory selected by project scripts to understand which
29
+ content shape drives the public UI.
23
30
 
24
31
  ## Ownership
25
32
 
@@ -17,8 +17,10 @@ skill remains the version-matched upgrade workflow, not a replacement CLI.
17
17
  1. Inspect git status, package.json, lockfile, actual project scripts and
18
18
  installed versions. Preserve unrelated local changes. Read plugin locks
19
19
  and legacy `.mantle` metadata if present; they are context, not required.
20
- 2. Select an explicit target release and read its entry in
21
- `docs/handbook/releases/index.md` plus that version's GitHub release notes.
20
+ 2. Select an explicit target release and read that version's GitHub release
21
+ notes. Installed docs live under `node_modules/@aotter/mantle/docs/`;
22
+ `handbook/releases/index.md` is a stable-release index, so a prerelease
23
+ need not appear there. Do not use the old package's docs as the new API contract.
22
24
  Do not resolve new Starter refs or compare the project to a baseline
23
25
  template.
24
26
  3. Update only selected `@aotter/mantle*` dependencies to the same exact target
@@ -39,6 +41,9 @@ pnpm exec mantle skills --check
39
41
  pnpm exec mantle validate
40
42
  ```
41
43
 
44
+ Read the refreshed `mantle-develop` skill and the upgraded package's embedded
45
+ docs before continuing application edits.
46
+
42
47
  Start the local application and test its actual routes, including configured
43
48
  auth behavior. Review the final source/lockfile/generated diff; unexpected
44
49
  provider or user-source changes block completion. Provider credentials must