@mnemonik/shared 1.0.0 → 5.75.3

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/src/usageGuide.ts CHANGED
@@ -4,14 +4,15 @@
4
4
  * This is the SINGLE SOURCE OF TRUTH for the usage guide.
5
5
  * Shared usage guide content imported by the server.
6
6
  *
7
- * Version: 2.80
8
- * Updated: 2026-02-20 - Aligned with instructions/rules/skill v2.80
7
+ * Version: 2.82
8
+ * Updated: 2026-05-27 - Doc-truth-contract-rebuild: teach authority-backed
9
+ * truth findings and keep legacy coupling drift diagnostic only.
9
10
  *
10
11
  * This guide focuses on HOW to use Mnemonik effectively, not WHAT tools exist.
11
12
  * Tool schemas already tell agents what's available - they need the workflow.
12
13
  */
13
14
 
14
- export const USAGE_GUIDE = `# Mnemonik Workflow Guide (v2.80)
15
+ export const USAGE_GUIDE = `# Mnemonik Workflow Guide (v2.82)
15
16
 
16
17
  ## Workflow
17
18
 
@@ -28,7 +29,7 @@ session_bootstrap → memory_search → file_context → [work] → memory_add
28
29
  ### Before editing files
29
30
  - file_context: fetch memories for the file — call for EVERY file you edit
30
31
  - memory_search: second search scoped to file/module if needed
31
- - docs(action: 'links'): check doc couplings for the file
32
+ - mnemonik.docs({ action: 'links' }): check doc couplings for the file
32
33
 
33
34
  ### During implementation
34
35
  - memory_get: retrieve specific memory by id
@@ -40,8 +41,7 @@ session_bootstrap → memory_search → file_context → [work] → memory_add
40
41
  - memory_add: save decisions, outcomes, patterns, bug root causes
41
42
  - memory_state: reinforce (memory helped), supersede (replace outdated), deprecate, penalize, dispute
42
43
  - tasks: mark tasks in progress or complete
43
- - docs(action: 'drift'): check for stale documentation after code changes
44
- - docs(action: 'resolve'): mark stale docs as fixed after updating them
44
+ - mnemonik.docs({ action: 'status' }): view doc-truth health (legacy coupling counts are diagnostic only — do not act on them as drift)
45
45
 
46
46
  ### Diagnostics
47
47
  - doctor: when tool calls fail or behavior is inconsistent
@@ -67,7 +67,7 @@ Never tell the user significant work is done without calling memory_add first in
67
67
  - Long sessions: re-run memory_search after switching topics
68
68
  - Conflicting info: use memory_state to supersede/dispute
69
69
  - High-impact changes: save memory immediately after verification
70
- - When file_context returns linkedDocs with driftStatus 'stale': update docs then docs(action: 'resolve')
70
+ - Act on docTruthFindings/_docDrift only when the finding has authority, observed mismatch, and agentAction='update_doc'; linkedDocs and stale-coupling counts are legacy diagnostics
71
71
 
72
72
  ## Anti-fade (every ~10 tool calls)
73
73