@nolrm/contextkit 1.0.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:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nolrm/contextkit",
3
- "version": "1.0.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": {