@redaksjon/protokoll 0.0.12 → 0.0.13
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/.cursor/rules/definition-of-done.md +1 -0
- package/.cursor/rules/no-emoticons.md +26 -12
- package/README.md +483 -69
- package/dist/agentic/executor.js +473 -41
- package/dist/agentic/executor.js.map +1 -1
- package/dist/agentic/index.js.map +1 -1
- package/dist/agentic/tools/lookup-person.js +123 -4
- package/dist/agentic/tools/lookup-person.js.map +1 -1
- package/dist/agentic/tools/lookup-project.js +139 -22
- package/dist/agentic/tools/lookup-project.js.map +1 -1
- package/dist/agentic/tools/route-note.js +5 -1
- package/dist/agentic/tools/route-note.js.map +1 -1
- package/dist/arguments.js +6 -3
- package/dist/arguments.js.map +1 -1
- package/dist/cli/action.js +704 -0
- package/dist/cli/action.js.map +1 -0
- package/dist/cli/config.js +482 -0
- package/dist/cli/config.js.map +1 -0
- package/dist/cli/context.js +466 -0
- package/dist/cli/context.js.map +1 -0
- package/dist/cli/feedback.js +858 -0
- package/dist/cli/feedback.js.map +1 -0
- package/dist/cli/index.js +103 -0
- package/dist/cli/index.js.map +1 -0
- package/dist/cli/install.js +572 -0
- package/dist/cli/install.js.map +1 -0
- package/dist/cli/transcript.js +199 -0
- package/dist/cli/transcript.js.map +1 -0
- package/dist/constants.js +11 -4
- package/dist/constants.js.map +1 -1
- package/dist/context/index.js +25 -1
- package/dist/context/index.js.map +1 -1
- package/dist/context/storage.js +56 -3
- package/dist/context/storage.js.map +1 -1
- package/dist/interactive/handler.js +310 -9
- package/dist/interactive/handler.js.map +1 -1
- package/dist/main.js +11 -1
- package/dist/main.js.map +1 -1
- package/dist/output/index.js.map +1 -1
- package/dist/output/manager.js +46 -1
- package/dist/output/manager.js.map +1 -1
- package/dist/phases/complete.js +37 -2
- package/dist/phases/complete.js.map +1 -1
- package/dist/pipeline/orchestrator.js +104 -31
- package/dist/pipeline/orchestrator.js.map +1 -1
- package/dist/protokoll.js +68 -2
- package/dist/protokoll.js.map +1 -1
- package/dist/reasoning/client.js +83 -0
- package/dist/reasoning/client.js.map +1 -1
- package/dist/reasoning/index.js +1 -0
- package/dist/reasoning/index.js.map +1 -1
- package/dist/util/metadata.js.map +1 -1
- package/dist/util/sound.js +116 -0
- package/dist/util/sound.js.map +1 -0
- package/docs/duplicate-question-prevention.md +117 -0
- package/docs/examples.md +152 -0
- package/docs/interactive-context-example.md +92 -0
- package/docs/package-lock.json +6 -0
- package/docs/package.json +3 -1
- package/guide/action.md +375 -0
- package/guide/config.md +207 -0
- package/guide/configuration.md +82 -67
- package/guide/context-commands.md +574 -0
- package/guide/context-system.md +20 -7
- package/guide/development.md +106 -4
- package/guide/feedback.md +335 -0
- package/guide/index.md +100 -4
- package/guide/interactive.md +15 -14
- package/guide/quickstart.md +21 -7
- package/guide/reasoning.md +18 -4
- package/guide/routing.md +192 -97
- package/package.json +1 -1
- package/scripts/coverage-priority.mjs +323 -0
- package/tsconfig.tsbuildinfo +1 -1
- package/vitest.config.ts +5 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# No Emoticons in Documentation
|
|
2
2
|
|
|
3
|
-
Do not use emoticons or
|
|
3
|
+
Do not use emoticons, emoji, or unicode symbols as grammatical decoration in documentation. This includes:
|
|
4
4
|
|
|
5
5
|
- README.md
|
|
6
6
|
- Guide files (guide/*.md)
|
|
@@ -8,36 +8,50 @@ Do not use emoticons or emoji in documentation files including:
|
|
|
8
8
|
- Prompt files (src/prompt/**/*.md)
|
|
9
9
|
- Any other markdown or documentation files
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## What to Avoid
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
**Never use emoticons or symbols for:**
|
|
14
14
|
|
|
15
|
-
-
|
|
16
|
-
-
|
|
15
|
+
- Decorating headings (🚀, 🎯, 📝, etc.)
|
|
16
|
+
- Bullet point prefixes (✅, ⭐, 👉, etc.)
|
|
17
|
+
- Emphasis or flair in prose
|
|
18
|
+
- Making lists look "fun" or "engaging"
|
|
17
19
|
|
|
18
|
-
|
|
20
|
+
Emoticons add visual noise without semantic value. Professional documentation communicates through clear language, not decorative symbols.
|
|
21
|
+
|
|
22
|
+
## Acceptable Uses
|
|
23
|
+
|
|
24
|
+
The following are acceptable because they convey actual meaning:
|
|
25
|
+
|
|
26
|
+
- ASCII checkmarks in feature comparison tables: ✓ and ✗
|
|
27
|
+
- Status indicators in CI/build tables where visual scanning matters
|
|
28
|
+
|
|
29
|
+
These should only appear in structured data tables, never in prose, headings, or list items.
|
|
19
30
|
|
|
20
31
|
## Examples
|
|
21
32
|
|
|
22
33
|
**Bad:**
|
|
34
|
+
|
|
23
35
|
```markdown
|
|
24
36
|
## 🚀 Getting Started
|
|
25
37
|
### 🎯 Features
|
|
26
38
|
- 📝 Smart transcription
|
|
39
|
+
- ✅ **For Developers**: Great tooling
|
|
27
40
|
```
|
|
28
41
|
|
|
29
42
|
**Good:**
|
|
43
|
+
|
|
30
44
|
```markdown
|
|
31
45
|
## Getting Started
|
|
32
46
|
### Features
|
|
33
47
|
- Smart transcription
|
|
48
|
+
- **For Developers**: Great tooling
|
|
34
49
|
```
|
|
35
50
|
|
|
36
|
-
**Acceptable (
|
|
51
|
+
**Acceptable (feature comparison tables only):**
|
|
52
|
+
|
|
37
53
|
```markdown
|
|
38
|
-
|
|
|
39
|
-
|
|
40
|
-
|
|
|
41
|
-
| Test | ❌ |
|
|
54
|
+
| Feature | Protokoll | Other |
|
|
55
|
+
|---------|-----------|-------|
|
|
56
|
+
| Name Recognition | ✓ | ✗ |
|
|
42
57
|
```
|
|
43
|
-
|