-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDOCS.json
More file actions
117 lines (117 loc) · 5.76 KB
/
Copy pathDOCS.json
File metadata and controls
117 lines (117 loc) · 5.76 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
{
"index": [
"DOCS.json",
"WORKFLOW.json",
"COMMANDS.json",
"FLOWS.json",
"SCRIPTS.json",
"QUALITY-GATE.json",
"JSON-FORMAT-CONTRACT.json",
"TODO.md",
"pipeline_featurelist.json",
"core/",
"core/WORKSPACE.json",
"core/CONTEXT-TIERS.json",
"core/communication-profiles/",
"profiles/",
"project/",
"templates/",
"tools/",
"docs-tech/",
"docs-tech/TOOL-ERRORS.json",
"AI-compiled/"
],
"content": {
"DOCS.json": {
"role": "Root document index for source-pipeline routing.",
"read": "at bootstrap or when document ownership is unclear"
},
"WORKFLOW.json": {
"role": "Root workflow guardrails and broad task policy.",
"read": "for every substantive source-pipeline prompt"
},
"COMMANDS.json": {
"role": "Root command keyword index.",
"read": "index only in default context; read content only for exact metadata about a matched command"
},
"FLOWS.json": {
"role": "Root ordered execution flows.",
"read": "after task classification and before broad edits"
},
"SCRIPTS.json": {
"role": "Root script availability index.",
"read": "index only in default context; read content only for exact metadata about a specific script"
},
"QUALITY-GATE.json": {
"role": "Canonical source-pipeline smoke and self-check command contract.",
"read": "when quality diagnostics, CI self-checks, or source-pipeline smoke coverage is in scope"
},
"TODO.md": {
"role": "Maintainer-side backlog for source-pipeline cleanup, audits, and deferred improvements not yet promoted into plan or feature contracts.",
"read": "when source-pipeline backlog, directive cleanup, or maintainer-side deferred work is relevant"
},
"pipeline_featurelist.json": {
"role": "Canonical source-pipeline feature manifest. It uses the stable JSON list-document shape: root index, content, and metadata.",
"read": "when pipeline-owned behavior changes",
"structure": "content.features stores the cheap feature-id comparison list; content.feature_contracts stores artifact contracts; metadata stores schema, pipeline identity, role, and comparison rules."
},
"core/": {
"role": "Shared agent contracts and protocols.",
"read": "when exact source-level behavior is needed"
},
"core/WORKSPACE.json": {
"role": "Workspace root marker contract. Defines where workspace.json lives, how tools discover it, and why project scripts should remain repo-relative.",
"read": "when workspace layout, import tooling, sibling SocratexAI source resolution, or work/projects path migration changes"
},
"core/CONTEXT-TIERS.json": {
"role": "Reusable context hierarchy contract for Tier 1-5 loading, budget sequencing, knowledge tier metadata, and consolidation triggers.",
"read": "when directive hierarchy, context budget, startup context, compiled knowledge routing, or knowledgebase retagging is in scope"
},
"project/": {
"role": "Project-type packs.",
"read": "when pack behavior or project type routing changes"
},
"templates/": {
"role": "Installed-project artifact templates.",
"read": "when initialization or reinitialization behavior changes"
},
"tools/": {
"role": "Pipeline automation scripts.",
"read": "before editing or bypassing automation"
},
"docs-tech/": {
"role": "Source-pipeline technical indexes, caches, and knowledge views.",
"read": "when compiled context or knowledge routing changes"
},
"AI-compiled/": {
"role": "Generated read-optimized instruction and knowledge cache.",
"read": "for fast orientation; do not edit by hand"
},
"docs-tech/TOOL-ERRORS.json": {
"role": "Registry of repeatable tool invocation, input, result, path, quoting, encoding, and contract failures that should harden scripts or script metadata.",
"read": "when a tool invocation or output failure repeats, or when tool_handler/tool_error_log behavior is being repaired"
},
"core/communication-profiles/": {
"role": "Plain-text communication profile registry. Each .txt filename is a communication.profile id and the file body is the source of truth for that response mode.",
"read": "when setup, initialization, communication behavior, or selected profile loading changes"
},
"profiles/": {
"role": "Reusable child-project profiles. Profiles define source-owned project-facing command, flow, script, and workflow artifacts that children consume as managed additions instead of forking ad hoc copies.",
"read": "when update, import, initialization, or child override behavior changes"
},
"JSON-FORMAT-CONTRACT.json": {
"role": "Canonical JSON format and exception contract.",
"audience": "ai",
"format": "json",
"read_when": "When changing JSON document shape, audit rules, templates, generated artifacts, or project memory formats.",
"write_when": "When adding a new JSON format family, migrating direct-schema files, or approving a non-canonical exception."
}
},
"metadata": {
"document": {
"title": "Source Pipeline Document Index",
"type": "document_index",
"language": "en"
}
}
}