Skip to content

Commit 48a7744

Browse files
zahzah
committed
docs: Add Obsidian and allow the schema validation to be skipped when the required software is missing
1 parent 34f8f20 commit 48a7744

File tree

8 files changed

+227
-4
lines changed

8 files changed

+227
-4
lines changed

‎.obsidian/app.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

‎.obsidian/appearance.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

‎.obsidian/core-plugins.json‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"file-explorer": true,
3+
"global-search": true,
4+
"switcher": true,
5+
"graph": true,
6+
"backlink": true,
7+
"canvas": true,
8+
"outgoing-link": true,
9+
"tag-pane": true,
10+
"properties": false,
11+
"page-preview": true,
12+
"daily-notes": true,
13+
"templates": true,
14+
"note-composer": true,
15+
"command-palette": true,
16+
"slash-command": false,
17+
"editor-status": true,
18+
"bookmarks": true,
19+
"markdown-importer": false,
20+
"zk-prefixer": false,
21+
"random-note": false,
22+
"outline": true,
23+
"word-count": true,
24+
"slides": false,
25+
"audio-recorder": false,
26+
"workspaces": false,
27+
"file-recovery": true,
28+
"publish": false,
29+
"sync": true,
30+
"webviewer": false
31+
}

‎.obsidian/workspace.json‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
{
2+
"main": {
3+
"id": "c48ce396b45cc07d",
4+
"type": "split",
5+
"children": [
6+
{
7+
"id": "6c596577ac3cdc4b",
8+
"type": "tabs",
9+
"children": [
10+
{
11+
"id": "01bf72509d2b5652",
12+
"type": "leaf",
13+
"state": {
14+
"type": "markdown",
15+
"state": {
16+
"file": "specs/configuration.md",
17+
"mode": "source",
18+
"source": false
19+
},
20+
"icon": "lucide-file",
21+
"title": "configuration"
22+
}
23+
}
24+
]
25+
}
26+
],
27+
"direction": "vertical"
28+
},
29+
"left": {
30+
"id": "0c16f4a905843b5c",
31+
"type": "split",
32+
"children": [
33+
{
34+
"id": "785ce5bc2160e7ef",
35+
"type": "tabs",
36+
"children": [
37+
{
38+
"id": "37c1846f5d192ea3",
39+
"type": "leaf",
40+
"state": {
41+
"type": "file-explorer",
42+
"state": {
43+
"sortOrder": "alphabetical",
44+
"autoReveal": false
45+
},
46+
"icon": "lucide-folder-closed",
47+
"title": "Files"
48+
}
49+
},
50+
{
51+
"id": "933d801c099c48a9",
52+
"type": "leaf",
53+
"state": {
54+
"type": "search",
55+
"state": {
56+
"query": "",
57+
"matchingCase": false,
58+
"explainSearch": false,
59+
"collapseAll": false,
60+
"extraContext": false,
61+
"sortOrder": "alphabetical"
62+
},
63+
"icon": "lucide-search",
64+
"title": "Search"
65+
}
66+
},
67+
{
68+
"id": "70a1789c58b6266f",
69+
"type": "leaf",
70+
"state": {
71+
"type": "bookmarks",
72+
"state": {},
73+
"icon": "lucide-bookmark",
74+
"title": "Bookmarks"
75+
}
76+
}
77+
]
78+
}
79+
],
80+
"direction": "horizontal",
81+
"width": 300
82+
},
83+
"right": {
84+
"id": "6bab4bb451c2c34d",
85+
"type": "split",
86+
"children": [
87+
{
88+
"id": "8eb63f2f86463431",
89+
"type": "tabs",
90+
"children": [
91+
{
92+
"id": "7cfa15c422463350",
93+
"type": "leaf",
94+
"state": {
95+
"type": "backlink",
96+
"state": {
97+
"file": "specs/configuration.md",
98+
"collapseAll": false,
99+
"extraContext": false,
100+
"sortOrder": "alphabetical",
101+
"showSearch": false,
102+
"searchQuery": "",
103+
"backlinkCollapsed": false,
104+
"unlinkedCollapsed": true
105+
},
106+
"icon": "links-coming-in",
107+
"title": "Backlinks for configuration"
108+
}
109+
},
110+
{
111+
"id": "56f8a2525bee7c1f",
112+
"type": "leaf",
113+
"state": {
114+
"type": "outgoing-link",
115+
"state": {
116+
"file": "specs/configuration.md",
117+
"linksCollapsed": false,
118+
"unlinkedCollapsed": true
119+
},
120+
"icon": "links-going-out",
121+
"title": "Outgoing links from configuration"
122+
}
123+
},
124+
{
125+
"id": "390225809e024d0d",
126+
"type": "leaf",
127+
"state": {
128+
"type": "tag",
129+
"state": {
130+
"sortOrder": "frequency",
131+
"useHierarchy": true,
132+
"showSearch": false,
133+
"searchQuery": ""
134+
},
135+
"icon": "lucide-tags",
136+
"title": "Tags"
137+
}
138+
},
139+
{
140+
"id": "642525d35ff8948f",
141+
"type": "leaf",
142+
"state": {
143+
"type": "outline",
144+
"state": {
145+
"file": "specs/configuration.md",
146+
"followCursor": false,
147+
"showSearch": false,
148+
"searchQuery": ""
149+
},
150+
"icon": "lucide-list",
151+
"title": "Outline of configuration"
152+
}
153+
}
154+
]
155+
}
156+
],
157+
"direction": "horizontal",
158+
"width": 300,
159+
"collapsed": true
160+
},
161+
"left-ribbon": {
162+
"hiddenItems": {
163+
"switcher:Open quick switcher": false,
164+
"graph:Open graph view": false,
165+
"canvas:Create new canvas": false,
166+
"daily-notes:Open today's daily note": false,
167+
"templates:Insert template": false,
168+
"command-palette:Open command palette": false
169+
}
170+
},
171+
"active": "01bf72509d2b5652",
172+
"lastOpenFiles": [
173+
"specs/cli-spec.md",
174+
"specs/configuration.md",
175+
"specs/connectivity-layer.md"
176+
]
177+
}

‎AGENTS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,6 @@ You can consult this file before starting your coding tasks.
4545

4646
## Writing git commit messages
4747

48-
- You MUST use multiline git commit messages.
48+
- You MUST use multiline git commit messages using heredoc syntax.
4949
- Use the convential commits style for the first line of the commit message.
5050
- Use the summary section of your final response as the remaining lines in the commit message.

‎Justfile‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,28 @@ publish-gem:
1717

1818
# Validate all JSON Schemas with ajv (meta-schema compile)
1919
conf-schema-validate:
20+
#!/usr/bin/env bash
2021
set -euo pipefail
22+
if command -v ajv >/dev/null 2>&1; then
23+
AJV=ajv
24+
else
25+
echo "ajv not found; using npx ajv-cli (requires network)" >&2
26+
AJV='npx -y ajv-cli'
27+
fi
2128
for f in specs/schemas/*.json; do
2229
echo Validating $$f
23-
ajv compile -s "$$f"
30+
$$AJV compile -s "$$f"
2431
done
2532
echo All schemas valid.
2633

2734
# Check TOML files with Taplo (uses schema mapping if configured)
2835
conf-schema-taplo-check:
36+
#!/usr/bin/env bash
37+
set -euo pipefail
38+
if ! command -v taplo >/dev/null 2>&1; then
39+
echo "taplo is not installed. Example to run once: nix shell ~/nixpkgs#taplo -c taplo check" >&2
40+
exit 127
41+
fi
2942
taplo check
3043

3144
# Serve schema docs locally with Docson (opens http://localhost:3000)

‎specs/cli-spec.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
The AW CLI (`aw`) unifies local and remote workflows for launching and managing agent coding sessions. Running `aw` with no subcommands starts the TUI dashboard. Subcommands provide scriptable operations for task/session lifecycle, configuration, repository management, and developer ergonomics.
66

7-
The CLI honors the layered configuration model in `docs/configuration.md` (system, user, project, project-user, env, CLI flags). Flags map from config keys using the `--a-b-c` convention and env var prefix `AGENTS_WORKFLOW_`.
7+
The CLI honors the layered configuration model in [[configuration]] (system, user, project, project-user, env, CLI flags). Flags map from config keys using the `--a-b-c` convention and env var prefix `AGENTS_WORKFLOW_`.
88

99
### Primary Goals
1010

‎specs/configuration.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* Motivation and support for tracking the origin of each configuration value, with use cases such as: debug-level log reporting, enforced setting explanation, and editor pre-fill mes
1010
sages.
1111

12-
Layered configuration supports system, user, project, and project-user scopes. Values can also be supplied via environment variables and CLI flags. See `specs/cli-spec.md` for flag mappings.
12+
Layered configuration supports system, user, project, and project-user scopes. Values can also be supplied via environment variables and CLI flags. See [[cli-spec.md]] for flag mappings.
1313

1414
### Keys
1515

0 commit comments

Comments
 (0)