@sumrco/cli 0.2.1 → 0.3.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.
- package/ai/modules/kontract/resources/api-generation-standards.rf.md +83 -0
- package/ai/modules/kontract/resources/authoring/configuration.rf.md +220 -0
- package/ai/modules/kontract/resources/authoring/design-profile/api-styles.rf.md +241 -0
- package/ai/modules/kontract/resources/authoring/design-profile/async-styles.rf.md +134 -0
- package/ai/modules/kontract/resources/authoring/design-profile/overview.md +64 -0
- package/ai/modules/kontract/resources/authoring/design-profile/schema-layout-styles.rf.md +356 -0
- package/ai/modules/kontract/resources/authoring/overview.md +56 -0
- package/ai/modules/kontract/resources/authoring/schema-reuse.rf.md +492 -0
- package/ai/modules/kontract/resources/authoring/scope-and-splitting.rf.md +244 -0
- package/ai/modules/kontract/resources/authoring/spec-layout.rf.md +492 -0
- package/ai/modules/kontract/resources/authoring/team-members/spec-author.tm.md +77 -0
- package/ai/modules/kontract/resources/{workflows/contract-change.wf.md → authoring/workflows/spec-change.wf.md} +24 -16
- package/ai/modules/kontract/resources/generated-output.rf.md +185 -17
- package/ai/modules/kontract/resources/openapi-sdk-generator-research.rf.md +57 -0
- package/ai/modules/kontract/resources/overview.md +130 -44
- package/ai/modules/kontract/resources/performance.rf.md +7 -7
- package/ai/modules/kontract/sumr.module.yaml +5 -2
- package/ai/modules/mission/sumr.module.yaml +6 -0
- package/ai/modules/playbook/resources/authoring/content-structure.rf.md +1 -1
- package/ai/modules/playbook/resources/authoring/cross-referencing.rf.md +1 -1
- package/ai/modules/playbook/resources/authoring/descriptions.rf.md +1 -1
- package/ai/modules/playbook/resources/authoring/extraction.rf.md +1 -1
- package/ai/modules/playbook/resources/authoring/flows.rf.md +1 -1
- package/ai/modules/playbook/resources/authoring/folder-structure.rf.md +1 -1
- package/ai/modules/playbook/resources/authoring/frontmatter.rf.md +4 -1
- package/ai/modules/playbook/resources/authoring/markdown.rf.md +1 -1
- package/ai/modules/playbook/resources/authoring/overview.md +1 -1
- package/ai/modules/playbook/resources/team-members/{playbook-technical-writer.tm.md → technical-writer.tm.md} +3 -2
- package/ai/modules/playbook/sumr.module.yaml +7 -2
- package/index.js +486 -284
- package/package.json +1 -1
- package/ai/modules/kontract/resources/configuration.rf.md +0 -123
- package/ai/modules/kontract/resources/openapi-generator-lessons.rf.md +0 -61
- package/ai/modules/kontract/resources/schema-reuse.rf.md +0 -233
- package/ai/modules/kontract/resources/scope-and-splitting.rf.md +0 -147
- package/ai/modules/kontract/resources/spec-layout.rf.md +0 -69
- package/ai/modules/kontract/resources/team-members/contract-author.tm.md +0 -52
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
category: reference
|
|
3
|
-
name:
|
|
3
|
+
name: authoring-cross-referencing
|
|
4
4
|
title: Cross-Referencing
|
|
5
5
|
description: "How to reference other topics within SUMR docs: use name for main topics, label for references. Never use file paths."
|
|
6
6
|
label: Cross-Refs
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
category: reference
|
|
3
|
-
name:
|
|
3
|
+
name: authoring-descriptions
|
|
4
4
|
title: Writing Descriptions
|
|
5
5
|
description: "Rules for writing effective frontmatter descriptions — third person, what-plus-when, specific key terms, length, and YAML safety."
|
|
6
6
|
label: Descriptions
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
category: reference
|
|
3
|
-
name:
|
|
3
|
+
name: authoring-flows
|
|
4
4
|
title: Flow Documentation
|
|
5
5
|
description: "Flow documentation patterns for Playbook docs, including compact arrow flows, human approval gates, Mermaid diagrams, and transition rules."
|
|
6
6
|
label: Flows
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
category: reference
|
|
3
|
-
name:
|
|
3
|
+
name: authoring-folder-structure
|
|
4
4
|
title: Folder Structure
|
|
5
5
|
description: "Recommended Playbook folder layout, top-level naming, team-member placement patterns (root vs domain-embedded), and standards folder naming alternatives."
|
|
6
6
|
label: Folder Structure
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
category: reference
|
|
3
|
-
name:
|
|
3
|
+
name: authoring-frontmatter
|
|
4
4
|
title: Frontmatter Schema
|
|
5
5
|
description: "Required and optional frontmatter fields, category values, and per-category validation rules for SUMR Playbook docs."
|
|
6
6
|
label: Frontmatter
|
|
@@ -48,6 +48,7 @@ description: "Test isolation rules, temp dir pattern, and integration test appro
|
|
|
48
48
|
| `effort` | `low \| medium \| high` | Reasoning depth for team-member/agent topics. Channels that support effort emit their native knob. |
|
|
49
49
|
| `access` | `read-only \| write \| full` | Permission posture. Channels translate it into their sandbox, tool, or permission model. |
|
|
50
50
|
| `tools` | `string[]` | Agnostic capability tokens (`read`, `edit`, `shell`, `web`, `todo`, `task`). Channels translate them into native tool names or permission keys. |
|
|
51
|
+
| `nicknames` | `string[]` | Friendly display names for spawned team-member instances. Codex renders this as `nickname_candidates`; other channels ignore it until they expose an equivalent. |
|
|
51
52
|
| `channels` | object | Legacy-compatible per-channel overrides. Prefer top-level native channel blocks in new docs. |
|
|
52
53
|
| `target` | string | Output filename override (basename only, extension inferred) |
|
|
53
54
|
|
|
@@ -60,6 +61,7 @@ modelTier: reasoning # reasoning | coding | fast → model class
|
|
|
60
61
|
effort: high # low | medium | high → Codex model_reasoning_effort
|
|
61
62
|
access: read-only # read-only | write | full → channel-native permission posture
|
|
62
63
|
tools: [read, web] # read | edit | shell | web | todo | task → channel-native tools/permissions
|
|
64
|
+
nicknames: [Atlas, Delta, Echo] # friendly spawned-instance labels when supported
|
|
63
65
|
```
|
|
64
66
|
|
|
65
67
|
`modelTier` → concrete model per channel:
|
|
@@ -101,6 +103,7 @@ name: codebase-reviewer
|
|
|
101
103
|
title: Codebase Reviewer
|
|
102
104
|
description: "Reviews code for correctness, security, behavior regressions, and missing tests."
|
|
103
105
|
modelTier: reasoning
|
|
106
|
+
nicknames: [Atlas, Delta, Echo]
|
|
104
107
|
|
|
105
108
|
# Codex CLI agent profile options
|
|
106
109
|
codex:
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
name:
|
|
2
|
+
name: authoring
|
|
3
3
|
title: Playbook Authoring
|
|
4
4
|
description: "How to write canonical SUMR Playbook docs: frontmatter schema, references, extraction markers, and authoring checklist. Use when creating or editing Markdown docs, technical docs, AI docs, agent skills, specs, runbooks, or Playbook sources."
|
|
5
5
|
tags: [authoring, docs, markdown, ai-docs, technical-docs, specs, skills]
|
|
@@ -1,17 +1,18 @@
|
|
|
1
1
|
---
|
|
2
2
|
category: team-member
|
|
3
|
-
name:
|
|
3
|
+
name: technical-writer
|
|
4
4
|
title: Playbook Technical Writer
|
|
5
5
|
description: "A SUMR Playbook authoring specialist. Use when drafting, reviewing, or restructuring canonical Playbook Markdown and AI resource docs."
|
|
6
6
|
modelTier: reasoning
|
|
7
7
|
access: read-only
|
|
8
|
+
nicknames: [Quill, Scribe, Editor]
|
|
8
9
|
---
|
|
9
10
|
|
|
10
11
|
# Playbook Technical Writer
|
|
11
12
|
|
|
12
13
|
You are responsible for producing canonical SUMR Playbook Markdown that can be rendered into multiple AI channels.
|
|
13
14
|
|
|
14
|
-
Apply **
|
|
15
|
+
Apply **authoring** before writing or editing Playbook docs.
|
|
15
16
|
|
|
16
17
|
## Responsibilities
|
|
17
18
|
|
|
@@ -39,9 +39,14 @@ spec:
|
|
|
39
39
|
summary: Print the canonical Playbook Markdown authoring contract
|
|
40
40
|
visibility: public
|
|
41
41
|
exports:
|
|
42
|
-
resources:
|
|
43
|
-
- ./resources
|
|
42
|
+
resources: []
|
|
44
43
|
binaries: []
|
|
44
|
+
aiResources:
|
|
45
|
+
module: playbook
|
|
46
|
+
roots:
|
|
47
|
+
- ./resources
|
|
48
|
+
activation:
|
|
49
|
+
mode: always
|
|
45
50
|
flags:
|
|
46
51
|
experimental: false
|
|
47
52
|
deprecated: null
|