noecosystem-design 0.1.1 → 0.1.2

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 CHANGED
@@ -10,9 +10,10 @@ registry metadata, reference apps, documentation, and verification contracts.
10
10
  # Give a coding agent the NOE source context.
11
11
  npm install noecosystem-design
12
12
 
13
- # The agent starts with these two files after installation:
13
+ # The agent starts with these files after installation:
14
14
  cat node_modules/noecosystem-design/AGENTS.md
15
15
  cat node_modules/noecosystem-design/llms.txt
16
+ cat node_modules/noecosystem-design/docs/design-system/gpt-agent-prompt.md
16
17
 
17
18
  # For a writable, verifiable workspace, use a repository checkout.
18
19
  git clone https://github.com/NOrchestration/noe-design-system.git
@@ -26,13 +27,11 @@ Read [`AGENTS.md`](AGENTS.md) before changing code. Use [`llms.txt`](llms.txt) a
26
27
  retrieval map, then read the affected package and component records. The canonical
27
28
  catalog is [`packages/registry/manifest.json`](packages/registry/manifest.json).
28
29
 
29
- Give an agent this task instruction after installation:
30
-
31
- > Read `node_modules/noecosystem-design/AGENTS.md` and `llms.txt` first. Find the
32
- > requested capability in `packages/registry/manifest.json`, reuse the documented
33
- > NOE pattern where appropriate, and report the files consulted plus executed
34
- > verification. Do not treat the package as a runtime import or the external registry
35
- > URL as deployed.
30
+ For a GPT coding agent, copy
31
+ [`docs/design-system/gpt-agent-prompt.md`](docs/design-system/gpt-agent-prompt.md),
32
+ replace `<TARGET_REPOSITORY>` and `<DESCRIBE THE REQUESTED OUTCOME...>`, and send it
33
+ as one task prompt. The template carries static NOE context once; put only the
34
+ requested outcome, scope, and non-negotiable constraints in its `Task` section.
36
35
 
37
36
  ## What `noecosystem-design` is — and is not
38
37
 
@@ -87,4 +86,6 @@ packages/registry Canonical component catalog and install metadata
87
86
 
88
87
  See [`docs/design-system/README.md`](docs/design-system/README.md) for the focused
89
88
  documentation index and [`docs/design-system/agent-guide.md`](docs/design-system/agent-guide.md)
90
- for the complete coding-agent workflow.
89
+ for the coding-agent workflow. The ready-to-paste
90
+ [`docs/design-system/gpt-agent-prompt.md`](docs/design-system/gpt-agent-prompt.md)
91
+ is the recommended task wrapper for GPT.
@@ -11,6 +11,7 @@ The documentation describes the implementation in this repository and marks exte
11
11
  - `i18n.md`, `rtl.md`: locale, direction and bidi architecture.
12
12
  - `accessibility.md`: WCAG-oriented requirements.
13
13
  - `testing.md`, `visual-qa.md`: test and evidence strategy.
14
+ - `gpt-agent-prompt.md`: ready-to-paste GPT task wrapper with outcome, autonomy, output, and stop rules.
14
15
  - `registry.md`, `mcp.md`, `agent-guide.md`: coding-agent discovery and package/registry boundaries.
15
16
  - `ci-cd.md`, `security.md`: automation and governance.
16
17
  - `contributing.md`: change workflow.
@@ -1,5 +1,13 @@
1
1
  # Coding-agent guide
2
2
 
3
+ ## Start a GPT task
4
+
5
+ Copy [`gpt-agent-prompt.md`](gpt-agent-prompt.md), replace its target repository and
6
+ `Task` placeholder, and send it as one prompt. Put the requested outcome, scope, and
7
+ non-negotiable constraints in `Task`; do not re-paste this guide or `AGENTS.md`.
8
+ The prompt already defines the agent's success criteria, autonomy boundary, response
9
+ format, and stop rules.
10
+
3
11
  ## Scope and distribution
4
12
 
5
13
  `noecosystem-design` is an npm-distributed source snapshot for discovery, review, and
@@ -18,27 +26,19 @@ The first-party `@noe` registry has local generation and consumer-test evidence.
18
26
  documented external endpoint must be treated as unavailable until deployment and
19
27
  official-MCP installation evidence exist; see `registry.md` and ADR 0007.
20
28
 
21
- ## Required intake
22
-
23
- 1. Read `README.md`, `AGENTS.md`, and the relevant focused document from `llms.txt`.
24
- 2. Search `packages/registry/manifest.json` by capability, alias, and component name.
25
- 3. Read the candidate item's `useWhen`, `doNotUseWhen`, `alternatives`, dependency,
26
- accessibility, and internationalization fields before opening implementation files.
27
- 4. Inspect the owning `packages/<package>/src` source and its Storybook story.
28
- 5. If no capability fits, follow the component lookup order in `AGENTS.md` and record
29
- why reuse was not appropriate.
30
-
31
- ## Implementation protocol
32
-
33
- 1. Prefer an existing NOE component or product pattern; never create a competing
34
- primitive for Button, Dialog, DataTable, ToolCall, or Approval.
35
- 2. Use semantic tokens, logical CSS properties, and the canonical i18n layer. Keep
36
- unpredictable prose `dir=auto`; isolate URLs, IDs, code, paths, and commands LTR.
37
- 3. Preserve semantic DOM order. Pass direction explicitly to portals; do not use
38
- global `row-reverse` or global icon mirroring as an RTL fix.
39
- 4. Keep ordinary tool output progressively disclosed and do not expose raw tool JSON
40
- by default.
41
- 5. Update source, stories, component tests, registry metadata, and docs together.
29
+ ## Retrieval and implementation
30
+
31
+ Read `README.md`, `AGENTS.md`, and the focused documentation selected by `llms.txt`.
32
+ Search `packages/registry/manifest.json` by capability, alias, and component name.
33
+ For a candidate, read its `useWhen`, `doNotUseWhen`, `alternatives`, dependency,
34
+ accessibility, and internationalization contracts before inspecting its source and
35
+ Storybook story. If nothing fits, use the component lookup order in `AGENTS.md` and
36
+ record the reason reuse was unsuitable.
37
+
38
+ `AGENTS.md` defines the implementation constraints: reuse canonical components;
39
+ preserve semantic tokens, i18n, RTL/bidi, portal direction, and progressive disclosure;
40
+ and update the relevant source, stories, tests, registry metadata, and documentation
41
+ together. Do not duplicate those instructions in a task prompt.
42
42
 
43
43
  ## Evidence before completion
44
44
 
@@ -0,0 +1,56 @@
1
+ # GPT implementation prompt
2
+
3
+ Use this after `npm install noecosystem-design`. Replace the values in angle
4
+ brackets, then send the complete prompt to the coding agent. Keep the static
5
+ context below intact; put task-specific details only in `Task`.
6
+
7
+ ```text
8
+ Role
9
+ You are the NOE design-system implementation agent working in <TARGET_REPOSITORY>.
10
+ Use the installed noecosystem-design package as a read-only source of design-system
11
+ context.
12
+
13
+ Task
14
+ <DESCRIBE THE REQUESTED OUTCOME, SCOPE, AND ANY NON-NEGOTIABLE CONSTRAINTS>
15
+
16
+ Success criteria
17
+ - The requested outcome works in the target repository.
18
+ - Reuse the relevant NOE capability or established product pattern before creating
19
+ new UI.
20
+ - Preserve every applicable NOE contract, including tokens, i18n, RTL/bidi,
21
+ accessibility, stories, tests, registry metadata, and documentation.
22
+ - Run checks that are proportionate to the change and report only results actually
23
+ observed.
24
+
25
+ Context
26
+ 1. Read node_modules/noecosystem-design/AGENTS.md and llms.txt first.
27
+ 2. Search node_modules/noecosystem-design/packages/registry/manifest.json for the
28
+ requested capability. Read the matching record and focused documentation before
29
+ implementation files.
30
+ 3. AGENTS.md is the authoritative static constraint set. Follow it without restating
31
+ it in the response.
32
+
33
+ Constraints
34
+ - noecosystem-design is a source snapshot, not a runtime dependency. Do not import
35
+ from it; use a writable repository checkout for implementation work.
36
+ - Do not present the public @noe registry as deployed or installable without direct
37
+ deployment evidence.
38
+ - Do safe local investigation, edits, and validation autonomously. Ask before an
39
+ external write, destructive action, purchase, credential change, or material scope
40
+ expansion.
41
+
42
+ Response
43
+ Lead with the outcome. Then give:
44
+ - Changed: only the material files or behavior changed.
45
+ - Evidence: commands run and their observed results.
46
+ - Blockers or risks: only if they materially affect completion.
47
+
48
+ Stop rules
49
+ Ask one focused question only when a material decision cannot be safely inferred.
50
+ Otherwise, finish when the success criteria are met. If evidence is unavailable,
51
+ state the exact gap instead of implying completion.
52
+ ```
53
+
54
+ The prompt intentionally states the goal, constraints, autonomy boundary, expected
55
+ output, and stop conditions once. Do not append a second copy of `AGENTS.md`; direct
56
+ the agent to the installed file instead.
package/llms.txt CHANGED
@@ -15,18 +15,21 @@
15
15
 
16
16
  ## Retrieval order
17
17
 
18
- 1. `README.md` — package scope, start path, commands, and distribution boundaries.
19
- 2. `AGENTS.md` mandatory design-system constraints and definition of done.
20
- 3. `packages/registry/manifest.json` — capability search, ownership, use/do-not-use
18
+ 1. `docs/design-system/gpt-agent-prompt.md` — ready-to-paste task wrapper for GPT;
19
+ replace only its target repository and task fields.
20
+ 2. `README.md` — package scope, start path, commands, and distribution boundaries.
21
+ 3. `AGENTS.md` — mandatory design-system constraints and definition of done.
22
+ 4. `packages/registry/manifest.json` — capability search, ownership, use/do-not-use
21
23
  rules, accessibility, i18n, dependencies, and story references.
22
- 4. `packages/registry/r/<item>.json` — installable-item metadata and source closure.
23
- 5. The owning package source under `packages/` and its Storybook story under
24
+ 5. `packages/registry/r/<item>.json` — installable-item metadata and source closure.
25
+ 6. The owning package source under `packages/` and its Storybook story under
24
26
  `apps/storybook/stories/`.
25
27
 
26
28
  ## Focused documentation
27
29
 
28
30
  - Architecture and package boundaries: `docs/design-system/architecture.md`
29
- - Agent workflow: `docs/design-system/agent-guide.md`
31
+ - GPT task wrapper: `docs/design-system/gpt-agent-prompt.md`
32
+ - Agent workflow and retrieval: `docs/design-system/agent-guide.md`
30
33
  - Components and catalog terms: `docs/design-system/components.md`
31
34
  - Tokens and foundations: `docs/design-system/foundations.md`, `docs/design-system/tokens.md`
32
35
  - Locale, RTL, and bidi: `docs/design-system/i18n.md`, `docs/design-system/rtl.md`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "noecosystem-design",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
4
  "private": false,
5
5
  "description": "Agent-readable NOE design-system source, registry metadata, and verification contracts.",
6
6
  "keywords": [