@nolrm/contextkit 0.21.0 → 1.0.1

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.
@@ -584,7 +584,7 @@ All documentation follows a 3-level hierarchy. Each level answers a different qu
584
584
 
585
585
  High-level system documentation: how the system is structured and how parts interact.
586
586
 
587
- - **Location:** \`docs/architecture.md\` in the project root (or any root-level docs folder)
587
+ - **Location:** Named file in the project root or a \`docs/\` folder (e.g. \`docs/architecture.md\`, \`docs/auth.md\`) one file per concern, not everything in \`README.md\`
588
588
  - **Scope:** Whole product, platform, or cross-cutting feature
589
589
  - **Content:** System/domain boundaries, main flows, how services/apps/packages connect and communicate
590
590
  - **Artifacts:** Diagrams (Mermaid or similar) for routing, sequence flows, context/containers; architecture decision notes; shared patterns and conventions
@@ -594,6 +594,7 @@ High-level system documentation: how the system is structured and how parts inte
594
594
 
595
595
  Documentation for a full screen, route, or feature area — the containers that hold many components.
596
596
 
597
+ - **Standard filename:** \`README.md\` in the feature/page directory
597
598
  - **Scope:** One app, one major feature, or one route/page
598
599
  - **Content:** Purpose of the page/feature, main sections and layout, which components and hooks are used, data/state and API usage, key user flows
599
600
  - **Artifacts:** Feature or page READMEs; lists of subcomponents and responsibilities; optional simple flow or layout sketches
@@ -603,9 +604,10 @@ Documentation for a full screen, route, or feature area — the containers that
603
604
 
604
605
  Documentation for a single component or a small, cohesive set of components.
605
606
 
607
+ - **Standard filename:** \`README.md\` colocated with the component
606
608
  - **Scope:** One component (or a tight group)
607
609
  - **Content:** What the component does, props/API, usage examples, behavior and edge cases, where it's used
608
- - **Artifacts:** README colocated next to the component; props table; code snippets
610
+ - **Artifacts:** \`README.md\` colocated next to the component; props table; code snippets
609
611
  - **Audience:** Developers implementing or reusing the component
610
612
 
611
613
  ## Project Architecture
@@ -645,6 +647,16 @@ Load standards files in this priority order to use your context window efficient
645
647
 
646
648
  If a standards file is longer than 200 lines, read the sections relevant to your task — not the whole file.
647
649
 
650
+ ## README.md Context Discovery
651
+
652
+ \`README.md\` is the standard context file at all 3 documentation levels. Before starting work in any directory or on any feature, check for it:
653
+
654
+ - **Architecture level**: project root or \`docs/\` directory
655
+ - **Feature/page level**: the directory containing the feature, route, or page you are working in
656
+ - **Component level**: the directory containing the component you are modifying
657
+
658
+ If a \`README.md\` exists at any of these levels relevant to your task, read it before acting. These files capture decisions, conventions, and context that the codebase alone does not reveal.
659
+
648
660
  ## Standards Loop
649
661
 
650
662
  This project follows a continuous standards loop:
@@ -1462,53 +1474,41 @@ Unlike [COMPETITOR_OR_ALTERNATIVE], we provide [SPECIFIC_ADVANTAGE]. This result
1462
1474
 
1463
1475
  const roadmapContent = `# Product Roadmap
1464
1476
 
1465
- ## Current Phase: [PHASE_NAME]
1477
+ ## Current Phase
1478
+
1479
+ <!-- Describe your current development phase, e.g. "Beta → v1.0 Stabilisation" or "Post-launch Growth" -->
1466
1480
 
1467
- ### Completed Features
1481
+ ### Completed ✅
1468
1482
 
1469
- - **[FEATURE]:** [DESCRIPTION]
1483
+ <!-- List features or milestones you have shipped -->
1470
1484
 
1471
1485
  ### In Progress 🚧
1472
1486
 
1473
- - **[FEATURE]:** [DESCRIPTION]
1487
+ <!-- List what your team is actively working on right now -->
1474
1488
 
1475
- ### Upcoming Features 📋
1489
+ ### Upcoming 📋
1476
1490
 
1477
- - **[FEATURE]:** [DESCRIPTION]
1491
+ <!-- List what is queued next, roughly in priority order -->
1478
1492
 
1479
1493
  ## Technical Debt & Improvements
1480
1494
 
1495
+ <!-- Track known improvements — helps AI assistants understand trade-offs and constraints -->
1496
+
1481
1497
  ### High Priority 🔴
1482
1498
 
1483
- - **[ITEM]:** [DESCRIPTION]
1499
+ <!-- Items that are blocking quality or causing pain -->
1484
1500
 
1485
1501
  ### Medium Priority 🟡
1486
1502
 
1487
- - **[ITEM]:** [DESCRIPTION]
1503
+ <!-- Important but not urgent -->
1488
1504
 
1489
1505
  ### Low Priority 🟢
1490
1506
 
1491
- - **[ITEM]:** [DESCRIPTION]
1492
-
1493
- ## Success Metrics
1494
-
1495
- ### Code Quality
1496
-
1497
- - **Test Coverage:** Target [X]%+
1498
- - **TypeScript Coverage:** [X]% for new code
1499
- - **Linting Errors:** Zero in CI
1500
-
1501
- ### Performance
1502
-
1503
- - **Page Load Time:** < [X] seconds
1504
- - **Bundle Size:** < [X]KB
1505
- - **Build Time:** < [X] minutes
1507
+ <!-- Nice-to-have improvements -->
1506
1508
 
1507
1509
  ## Future Vision
1508
1510
 
1509
- ### [QUARTER/YEAR]: [THEME]
1510
-
1511
- - [FEATURE_OR_GOAL]
1511
+ <!-- Optional: sketch longer-horizon goals so AI assistants understand the direction -->
1512
1512
  `;
1513
1513
 
1514
1514
  const decisionsContent = `# Technical Decisions
package/package.json CHANGED
@@ -1,13 +1,11 @@
1
1
  {
2
2
  "name": "@nolrm/contextkit",
3
- "version": "0.21.0",
3
+ "version": "1.0.1",
4
4
  "description": "ContextKit - Context Engineering + Agentic AI Pipelines. Scaffold structured standards for AI assistants and run autonomous multi-role pipelines (PO → Architect → Dev → Test → Review → Doc) grounded by that same context layer. Works with Cursor, Claude Code, Copilot, Codex, Gemini, Aider, and more.",
5
5
  "main": "lib/index.js",
6
6
  "bin": {
7
7
  "contextkit": "bin/contextkit.js",
8
- "ck": "bin/contextkit.js",
9
- "vibe-kit": "bin/vibe-kit.js",
10
- "vk": "bin/vibe-kit.js"
8
+ "ck": "bin/contextkit.js"
11
9
  },
12
10
  "scripts": {
13
11
  "format": "prettier --write \"lib/**/*.js\" \"bin/**/*.js\" \"__tests__/**/*.js\"",
@@ -19,7 +17,6 @@
19
17
  },
20
18
  "keywords": [
21
19
  "contextkit",
22
- "vibe-kit",
23
20
  "context-engineering",
24
21
  "ai-context",
25
22
  "ai-development",
package/bin/vibe-kit.js DELETED
@@ -1,3 +0,0 @@
1
- #!/usr/bin/env node
2
- console.warn('\x1b[33m"vibe-kit" is deprecated. Use "contextkit" or "ck" instead.\x1b[0m');
3
- require('./contextkit.js');