nocaap 0.0.2 → 0.0.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.
- package/README.md +43 -0
- package/dist/index.js +3296 -2997
- package/dist/index.js.map +1 -1
- package/package.json +12 -2
package/README.md
CHANGED
|
@@ -44,6 +44,30 @@ pnpm run build
|
|
|
44
44
|
npm link
|
|
45
45
|
```
|
|
46
46
|
|
|
47
|
+
## ⚡ 5-Minute Quick Start (Human Flow)
|
|
48
|
+
|
|
49
|
+
Use this if you want the shortest path from install to merged PR.
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
# 1) Install
|
|
53
|
+
npm install -g nocaap
|
|
54
|
+
|
|
55
|
+
# 2) Set your org registry
|
|
56
|
+
nocaap config registry https://github.com/your-org/context-hub
|
|
57
|
+
|
|
58
|
+
# 3) Install contexts in this project
|
|
59
|
+
nocaap setup
|
|
60
|
+
|
|
61
|
+
# 4) Sync before editing/pushing
|
|
62
|
+
nocaap update <alias>
|
|
63
|
+
|
|
64
|
+
# 5) Push changes as a PR
|
|
65
|
+
nocaap push <alias> -m "Update documentation"
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Then open the PR URL, review, and use **Squash and merge** in GitHub web UI.
|
|
69
|
+
For the full walkthrough, see [`docs/GETTING_STARTED.md`](./docs/GETTING_STARTED.md).
|
|
70
|
+
|
|
47
71
|
## 🏗️ Setting Up Your Organization's Context Hub
|
|
48
72
|
|
|
49
73
|
Want to create your own context registry? Use the **official starter template**:
|
|
@@ -156,6 +180,14 @@ nocaap push engineering -m "Update API documentation"
|
|
|
156
180
|
- Auto-creates PR via gh CLI or GitHub API
|
|
157
181
|
- Detects upstream divergence (requires `nocaap update` first)
|
|
158
182
|
|
|
183
|
+
**After `nocaap push` (default flow):**
|
|
184
|
+
1. Open the PR URL printed by the CLI.
|
|
185
|
+
2. Review files and wait for checks.
|
|
186
|
+
3. Use **Squash and merge** in GitHub web UI.
|
|
187
|
+
4. Optionally delete the branch.
|
|
188
|
+
|
|
189
|
+
Full guide: [`docs/GITHUB_WORKFLOW.md`](./docs/GITHUB_WORKFLOW.md)
|
|
190
|
+
|
|
159
191
|
### 5. Build Search Index
|
|
160
192
|
|
|
161
193
|
Build a searchable index for AI agents to query your context.
|
|
@@ -243,6 +275,17 @@ nocaap generate
|
|
|
243
275
|
| `nocaap serve` | Start MCP server for AI agents |
|
|
244
276
|
| `nocaap config [key] [value]` | Manage configuration |
|
|
245
277
|
|
|
278
|
+
## 📚 Human Documentation
|
|
279
|
+
|
|
280
|
+
These guides are written for people (not agent instructions):
|
|
281
|
+
|
|
282
|
+
- [Documentation Index](./docs/README.md)
|
|
283
|
+
- [Getting Started](./docs/GETTING_STARTED.md)
|
|
284
|
+
- [GitHub Workflow](./docs/GITHUB_WORKFLOW.md)
|
|
285
|
+
- [Troubleshooting](./docs/TROUBLESHOOTING.md)
|
|
286
|
+
- [FAQ](./docs/FAQ.md)
|
|
287
|
+
- [Releasing (maintainers)](./docs/RELEASING.md)
|
|
288
|
+
|
|
246
289
|
## 📂 Directory Structure
|
|
247
290
|
|
|
248
291
|
`nocaap` manages everything inside `.context/`. You should commit `context.config.json` and `context.lock`, but **ignore** the packages.
|