openclew 0.3.0 → 0.4.0
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/LICENSE +190 -21
- package/README.md +35 -2
- package/bin/openclew.js +3 -0
- package/commands/oc-checkout.md +134 -0
- package/commands/oc-init.md +27 -0
- package/commands/oc-peek.md +41 -0
- package/commands/oc-search.md +25 -0
- package/commands/oc-status.md +20 -0
- package/lib/checkout.js +2 -4
- package/lib/init.js +61 -0
- package/lib/inject.js +1 -0
- package/lib/peek.js +166 -0
- package/package.json +5 -14
- package/skills/{openclew-checkpoint → oc-checkpoint}/SKILL.md +1 -1
- package/skills/{openclew-init → oc-init}/SKILL.md +1 -1
- package/skills/{openclew-search → oc-search}/SKILL.md +1 -1
- package/templates/FORMAT.md +6 -5
package/LICENSE
CHANGED
|
@@ -1,21 +1,190 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to the Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by the Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding any notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
Copyright 2026 R.AlphA
|
|
179
|
+
|
|
180
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
181
|
+
you may not use this file except in compliance with the License.
|
|
182
|
+
You may obtain a copy of the License at
|
|
183
|
+
|
|
184
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
185
|
+
|
|
186
|
+
Unless required by applicable law or agreed to in writing, software
|
|
187
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
188
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
189
|
+
See the License for the specific language governing permissions and
|
|
190
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -112,6 +112,31 @@ Next session, your agent reads the index, finds the doc, has the context. No re-
|
|
|
112
112
|
|
|
113
113
|
The index auto-regenerates on every commit. Never edit it manually.
|
|
114
114
|
|
|
115
|
+
### CLI commands
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
openclew init # Set up openclew in your project
|
|
119
|
+
openclew add ref <title> # Create a refdoc (evolves with the project)
|
|
120
|
+
openclew add log <title> # Create a session log (frozen facts)
|
|
121
|
+
openclew search <query> # Search docs by keyword
|
|
122
|
+
openclew checkout # End-of-session summary
|
|
123
|
+
openclew status # Documentation health dashboard
|
|
124
|
+
openclew mcp # Start MCP server (stdio JSON-RPC)
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
### Claude Code slash commands
|
|
128
|
+
|
|
129
|
+
`openclew init` installs 4 slash commands into Claude Code:
|
|
130
|
+
|
|
131
|
+
| Command | What it does |
|
|
132
|
+
|---------|-------------|
|
|
133
|
+
| `/oc-checkout` | End-of-session summary — review actions, create log, commit |
|
|
134
|
+
| `/oc-search` | Search project docs by keyword |
|
|
135
|
+
| `/oc-init` | Set up openclew in the current project |
|
|
136
|
+
| `/oc-status` | Documentation health dashboard |
|
|
137
|
+
|
|
138
|
+
These work like any Claude Code slash command — type `/oc-` and pick one. No `npx` needed.
|
|
139
|
+
|
|
115
140
|
<details>
|
|
116
141
|
<summary><b>Manual setup</b> — if you prefer not to use the CLI</summary>
|
|
117
142
|
|
|
@@ -180,7 +205,15 @@ doc/
|
|
|
180
205
|
|
|
181
206
|
**Workflow frameworks:** BMAD, Spec Kit, or any methodology — openclew handles knowledge, your framework handles process.
|
|
182
207
|
|
|
183
|
-
**
|
|
208
|
+
**What the CLI does for you:**
|
|
209
|
+
- Detects your instruction file (CLAUDE.md, .cursorrules, AGENTS.md, copilot-instructions...)
|
|
210
|
+
- Injects a knowledge block that teaches your agent about the doc structure
|
|
211
|
+
- Generates and regenerates the index on every commit (pre-commit hook)
|
|
212
|
+
- Searches docs by keyword with weighted scoring (`openclew search`)
|
|
213
|
+
- Exposes docs via MCP server for tool-aware agents (`openclew mcp`)
|
|
214
|
+
- Produces a session summary at end of work (`openclew checkout`)
|
|
215
|
+
|
|
216
|
+
**What you get:** plain Markdown files. Git-versioned, diffable, reviewable in PRs. Zero npm dependencies — Node 16+ is all you need. No lock-in: if you stop using the CLI, the docs are still useful — to humans and agents alike.
|
|
184
217
|
|
|
185
218
|
---
|
|
186
219
|
|
|
@@ -202,4 +235,4 @@ doc/
|
|
|
202
235
|
|
|
203
236
|
## License
|
|
204
237
|
|
|
205
|
-
|
|
238
|
+
Apache 2.0 — use it however you want. Patent protection included.
|
package/bin/openclew.js
CHANGED
|
@@ -13,6 +13,7 @@ Usage:
|
|
|
13
13
|
openclew add ref <title> Create a refdoc (evolves with the project)
|
|
14
14
|
openclew add log <title> Create a session log (frozen facts)
|
|
15
15
|
openclew search <query> Search docs by keyword
|
|
16
|
+
openclew peek List instruction file + all refdocs
|
|
16
17
|
openclew checkout End-of-session summary
|
|
17
18
|
|
|
18
19
|
Run 'openclew help --all' for advanced commands.
|
|
@@ -27,6 +28,7 @@ Usage:
|
|
|
27
28
|
openclew add ref <title> Create a refdoc (evolves with the project)
|
|
28
29
|
openclew add log <title> Create a session log (frozen facts)
|
|
29
30
|
openclew search <query> Search docs by keyword
|
|
31
|
+
openclew peek List instruction file + all refdocs
|
|
30
32
|
openclew checkout End-of-session summary
|
|
31
33
|
|
|
32
34
|
Advanced:
|
|
@@ -67,6 +69,7 @@ const commands = {
|
|
|
67
69
|
log: () => require("../lib/new-log"),
|
|
68
70
|
checkout: () => require("../lib/checkout"),
|
|
69
71
|
search: () => require("../lib/search"),
|
|
72
|
+
peek: () => require("../lib/peek"),
|
|
70
73
|
status: () => require("../lib/status"),
|
|
71
74
|
index: () => require("../lib/index-gen"),
|
|
72
75
|
mcp: () => require("../lib/mcp-server"),
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
<!-- openclew-managed -->
|
|
2
|
+
# oc-checkout — End-of-session summary
|
|
3
|
+
|
|
4
|
+
Generates a structured summary of the session and persists it as a log.
|
|
5
|
+
|
|
6
|
+
**Usage:** `/oc-checkout` (no arguments, uses the current project)
|
|
7
|
+
|
|
8
|
+
## Key principle
|
|
9
|
+
|
|
10
|
+
**Commits happen AFTER the checkout**, never during. This allows including logs created during checkout in the same commit.
|
|
11
|
+
|
|
12
|
+
## Status emojis
|
|
13
|
+
|
|
14
|
+
| Emoji | Column | Meaning |
|
|
15
|
+
|-------|--------|---------|
|
|
16
|
+
| ✅ | Status | Done |
|
|
17
|
+
| 🚧 | Status | In progress / partial |
|
|
18
|
+
| ❌ | Status | Not done |
|
|
19
|
+
| 📗 | Doc | Documented (log, refdoc, or instruction file) |
|
|
20
|
+
| 📕 | Doc | Not documented |
|
|
21
|
+
| 🟢 | Commit | Already committed |
|
|
22
|
+
| 🟡 | Commit | To be committed |
|
|
23
|
+
|
|
24
|
+
## Sequence
|
|
25
|
+
|
|
26
|
+
### Phase 1: Collection (silent)
|
|
27
|
+
|
|
28
|
+
Execute silently — go straight to the Phase 2 table:
|
|
29
|
+
1. Run `npx openclew checkout` to collect git activity and display the CLI summary
|
|
30
|
+
2. List session actions (features, bugs, refactors...)
|
|
31
|
+
3. Check which files are documented (`doc/log/*.md`, `doc/_*.md`)
|
|
32
|
+
4. Check git status of each file (committed or not)
|
|
33
|
+
|
|
34
|
+
### Phase 2: Summary table
|
|
35
|
+
|
|
36
|
+
Display the recap table for validation.
|
|
37
|
+
|
|
38
|
+
**Format:**
|
|
39
|
+
- Box-drawing (no Markdown pipes)
|
|
40
|
+
- **Isolated emojis** in dedicated mini-columns (never emoji + text in the same cell)
|
|
41
|
+
- Emoji columns: **5 chars wide** (`─────`) with **2 spaces after emoji** (`│ ✅ │`)
|
|
42
|
+
- Action column: **max 50 chars** (rephrase/abbreviate if needed, never truncate)
|
|
43
|
+
- No separator `├───┤` between data rows, only after the header
|
|
44
|
+
|
|
45
|
+
**Example:**
|
|
46
|
+
```
|
|
47
|
+
┌─────┬──────────────────────────────────────┬─────┬────────────────────────┬─────┐
|
|
48
|
+
│ Sta │ Action │ Doc │ File │Comm.│
|
|
49
|
+
├─────┼──────────────────────────────────────┼─────┼────────────────────────┼─────┤
|
|
50
|
+
│ ✅ │ Feature: Auth middleware refactor │ 📗 │ 2026-01-15_auth.md │ 🟢 │
|
|
51
|
+
│ 🚧 │ Fix: Table alignment │ 📕 │ Not documented │ 🟡 │
|
|
52
|
+
└─────┴──────────────────────────────────────┴─────┴────────────────────────┴─────┘
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Phase 3: Refdocs to update?
|
|
56
|
+
|
|
57
|
+
1. List refdocs: all `doc/_*.md` files (excluding `_INDEX.md`) + project instruction file (CLAUDE.md, AGENTS.md, etc.)
|
|
58
|
+
2. Filter those related to session actions (by name only — don't read yet)
|
|
59
|
+
3. For each related doc: read and assign status:
|
|
60
|
+
- ☑️ No update needed (verified, up to date)
|
|
61
|
+
- ✅ Already updated during session
|
|
62
|
+
- 📒 Needs update (proposed in Phase 4)
|
|
63
|
+
4. **Instruction file**: always evaluated. Flag 📒 if:
|
|
64
|
+
- New refdoc created during session (needs reference)
|
|
65
|
+
- Useful info discovered (pitfall, convention, command)
|
|
66
|
+
- Stale context (abandoned topic, modified rule)
|
|
67
|
+
- File missing (needs creation)
|
|
68
|
+
5. Display all related docs with status:
|
|
69
|
+
|
|
70
|
+
```
|
|
71
|
+
📚 Refdocs:
|
|
72
|
+
✅ _AUTH_DESIGN.md — updated (session section)
|
|
73
|
+
☑️ _ARCHITECTURE.md — verified, up to date
|
|
74
|
+
📒 _INSTALL_GUIDE.md — new deploy step to document
|
|
75
|
+
📒 CLAUDE.md — new pitfall discovered
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Phase 4: Proposed actions (grouped)
|
|
79
|
+
|
|
80
|
+
Display all actions together:
|
|
81
|
+
|
|
82
|
+
```
|
|
83
|
+
─── Proposed actions ───
|
|
84
|
+
|
|
85
|
+
1. [ ] Create log for "Fix: Description" → `2026-01-15_topic.md`
|
|
86
|
+
2. [ ] Update CLAUDE.md (modified context)
|
|
87
|
+
|
|
88
|
+
Approve actions? (yes/no/modify)
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
- Wait for user validation
|
|
92
|
+
- If "modify": user indicates changes, adapt, re-validate
|
|
93
|
+
- Execute validated actions (create logs, updates)
|
|
94
|
+
|
|
95
|
+
### Phase 5: Commits (AFTER everything else)
|
|
96
|
+
|
|
97
|
+
Execute directly after action validation:
|
|
98
|
+
|
|
99
|
+
1. Check `git status` for all files to commit
|
|
100
|
+
2. Execute commit(s)
|
|
101
|
+
3. Logs created in Phase 4 are included
|
|
102
|
+
4. Display result
|
|
103
|
+
|
|
104
|
+
## Closing message
|
|
105
|
+
|
|
106
|
+
**Mandatory at the end of checkout.** Displayed after commits.
|
|
107
|
+
|
|
108
|
+
```
|
|
109
|
+
─── Summary ───
|
|
110
|
+
1. Concrete fact #1 (short sentence)
|
|
111
|
+
2. Concrete fact #2
|
|
112
|
+
|
|
113
|
+
✅📗🟢 Feature: Description → file.md
|
|
114
|
+
🚧📕🟡 Fix: Description → (not documented)
|
|
115
|
+
|
|
116
|
+
─── How to test ───
|
|
117
|
+
• manual action or command → expected result
|
|
118
|
+
|
|
119
|
+
─── Next steps ───
|
|
120
|
+
⏭️📗 Test the new feature → CLAUDE.md TODO
|
|
121
|
+
⏭️📕 Explore WebSocket option
|
|
122
|
+
|
|
123
|
+
═══════════════════════════════════════
|
|
124
|
+
🏁 Session complete
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
**Compact format — 3 emojis concatenated:**
|
|
128
|
+
- Position 1: status (✅ done / 🚧 in progress / ❌ not done)
|
|
129
|
+
- Position 2: documentation (📗 yes / 📕 no)
|
|
130
|
+
- Position 3: commit (🟢 yes / 🟡 no)
|
|
131
|
+
|
|
132
|
+
**Closing rule:**
|
|
133
|
+
- `🏁 Session complete`: only if all actions are ✅📗🟢
|
|
134
|
+
- Otherwise: `⏸️ Session incomplete` and list what remains
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
<!-- openclew-managed -->
|
|
2
|
+
# oc-init — Set up openclew in the current project
|
|
3
|
+
|
|
4
|
+
Initialize structured documentation so AI agents and humans navigate project knowledge efficiently.
|
|
5
|
+
|
|
6
|
+
**Usage:** `/oc-init`
|
|
7
|
+
|
|
8
|
+
## Sequence
|
|
9
|
+
|
|
10
|
+
1. Run `npx openclew init`
|
|
11
|
+
2. Display what was created
|
|
12
|
+
3. Read the generated guide (`doc/_USING_OPENCLEW.md`) to understand the setup
|
|
13
|
+
4. Propose creating a first architecture doc:
|
|
14
|
+
- "Want me to create `doc/_ARCHITECTURE.md` based on the current project structure?"
|
|
15
|
+
- If yes: analyze the project (main dirs, stack, key files) and fill in the template
|
|
16
|
+
|
|
17
|
+
## After setup
|
|
18
|
+
|
|
19
|
+
The agent will now consult `doc/_INDEX.md` before starting tasks. Available commands:
|
|
20
|
+
|
|
21
|
+
- `/oc-search <query>` — Search existing docs
|
|
22
|
+
- `/oc-status` — Health dashboard
|
|
23
|
+
- `/oc-checkout` — End-of-session summary
|
|
24
|
+
|
|
25
|
+
To add knowledge manually:
|
|
26
|
+
- `npx openclew add ref "Title"` — Create a reference doc
|
|
27
|
+
- `npx openclew add log "Title"` — Create a session log
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
<!-- openclew-managed -->
|
|
2
|
+
# oc-peek — Discover project knowledge before working
|
|
3
|
+
|
|
4
|
+
First reflex before exploring a project: shows the instruction file and lists all available docs.
|
|
5
|
+
|
|
6
|
+
**Usage:** `/oc-peek` (no arguments, uses the current project)
|
|
7
|
+
|
|
8
|
+
## Sequence
|
|
9
|
+
|
|
10
|
+
### Step 1: Run the CLI
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npx openclew peek
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
This lists:
|
|
17
|
+
- The instruction file (CLAUDE.md / AGENTS.md) path
|
|
18
|
+
- All refdocs in `doc/` with their subjects
|
|
19
|
+
- All `_*.md` files outside `doc/` (prompts, scripts, etc.)
|
|
20
|
+
- Subdirectories of `doc/`
|
|
21
|
+
|
|
22
|
+
### Step 2: Display the instruction file
|
|
23
|
+
|
|
24
|
+
Read the instruction file (CLAUDE.md or AGENTS.md) and display it **in full** — do not summarize.
|
|
25
|
+
|
|
26
|
+
### Step 3: Display the refdoc list
|
|
27
|
+
|
|
28
|
+
Display the CLI output as-is. This is a **listing only** — do not read the refdocs at this stage.
|
|
29
|
+
|
|
30
|
+
## Rules
|
|
31
|
+
|
|
32
|
+
- **Do not summarize** the instruction file — display it integrally
|
|
33
|
+
- **Do not read** the refdocs — list file names only
|
|
34
|
+
- If no instruction file exists: indicate `(no instruction file found)`
|
|
35
|
+
- If no `doc/` directory exists: indicate `(no doc/ directory)`
|
|
36
|
+
|
|
37
|
+
## Related commands
|
|
38
|
+
|
|
39
|
+
- `/oc-search <query>` — Search docs by keyword
|
|
40
|
+
- `/oc-status` — Documentation health dashboard
|
|
41
|
+
- `/oc-checkout` — End-of-session summary
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
<!-- openclew-managed -->
|
|
2
|
+
# oc-search — Search project documentation
|
|
3
|
+
|
|
4
|
+
Search your project's knowledge base by keyword.
|
|
5
|
+
|
|
6
|
+
**Usage:** `/oc-search <query>`
|
|
7
|
+
|
|
8
|
+
## Sequence
|
|
9
|
+
|
|
10
|
+
1. Run `npx openclew search "$ARGUMENTS"` to get results
|
|
11
|
+
2. Display results to the user
|
|
12
|
+
3. If results found: propose to read the most relevant doc(s) at L2 level
|
|
13
|
+
4. If no results: suggest alternative keywords or propose creating a new doc
|
|
14
|
+
|
|
15
|
+
## Reading results
|
|
16
|
+
|
|
17
|
+
After finding a doc, read it progressively:
|
|
18
|
+
- **L1** (between `L1_START`/`L1_END`) — subject + brief, ~40 tokens. "Should I read this?"
|
|
19
|
+
- **L2** (between `L2_START`/`L2_END`) — summary, essential context
|
|
20
|
+
- **L3** (between `L3_START`/`L3_END`) — full details, only when deep-diving
|
|
21
|
+
|
|
22
|
+
## Related commands
|
|
23
|
+
|
|
24
|
+
- `/oc-status` — Health dashboard (missing briefs, stale docs)
|
|
25
|
+
- `/oc-checkout` — End-of-session summary
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
<!-- openclew-managed -->
|
|
2
|
+
# oc-status — Documentation health dashboard
|
|
3
|
+
|
|
4
|
+
Display the health status of project documentation.
|
|
5
|
+
|
|
6
|
+
**Usage:** `/oc-status`
|
|
7
|
+
|
|
8
|
+
## Sequence
|
|
9
|
+
|
|
10
|
+
1. Run `npx openclew status` to get the dashboard
|
|
11
|
+
2. Display results to the user
|
|
12
|
+
3. If issues found, propose actions:
|
|
13
|
+
- **Missing doc_brief**: "These docs have empty briefs — want me to fill them in?"
|
|
14
|
+
- **Stale docs**: "These docs haven't been updated in a while — want me to review them?"
|
|
15
|
+
- **No recent logs**: "No log created recently — want me to create one for this session?"
|
|
16
|
+
|
|
17
|
+
## Related commands
|
|
18
|
+
|
|
19
|
+
- `/oc-search <query>` — Search docs by keyword
|
|
20
|
+
- `/oc-checkout` — End-of-session summary (also creates logs)
|
package/lib/checkout.js
CHANGED
|
@@ -253,11 +253,9 @@ ${commitList}
|
|
|
253
253
|
}
|
|
254
254
|
|
|
255
255
|
function regenerateIndex() {
|
|
256
|
-
const indexScript = path.join(DOC_DIR, "generate-index.py");
|
|
257
|
-
if (!fs.existsSync(indexScript)) return;
|
|
258
|
-
|
|
259
256
|
try {
|
|
260
|
-
|
|
257
|
+
const { writeIndex } = require("./index-gen");
|
|
258
|
+
writeIndex(DOC_DIR);
|
|
261
259
|
console.log(" 📋 Regenerated doc/_INDEX.md");
|
|
262
260
|
} catch {
|
|
263
261
|
// Silent — index will be regenerated on next commit anyway
|
package/lib/init.js
CHANGED
|
@@ -240,6 +240,58 @@ function runIndexGenerator() {
|
|
|
240
240
|
}
|
|
241
241
|
}
|
|
242
242
|
|
|
243
|
+
function installSlashCommands() {
|
|
244
|
+
const home = process.env.HOME || process.env.USERPROFILE;
|
|
245
|
+
if (!home) {
|
|
246
|
+
console.log(" Cannot determine home directory — skipping");
|
|
247
|
+
return;
|
|
248
|
+
}
|
|
249
|
+
|
|
250
|
+
const claudeCommandsDir = path.join(home, ".claude", "commands");
|
|
251
|
+
if (!fs.existsSync(path.join(home, ".claude"))) {
|
|
252
|
+
console.log(" No ~/.claude/ found (Claude Code not installed) — skipping");
|
|
253
|
+
return;
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
if (!fs.existsSync(claudeCommandsDir)) {
|
|
257
|
+
fs.mkdirSync(claudeCommandsDir, { recursive: true });
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
// Find commands/ dir relative to this package
|
|
261
|
+
const pkgCommandsDir = path.join(__dirname, "..", "commands");
|
|
262
|
+
if (!fs.existsSync(pkgCommandsDir)) {
|
|
263
|
+
console.log(" No commands/ directory in package — skipping");
|
|
264
|
+
return;
|
|
265
|
+
}
|
|
266
|
+
|
|
267
|
+
const MARKER = "<!-- openclew-managed -->";
|
|
268
|
+
const files = fs.readdirSync(pkgCommandsDir).filter((f) => f.endsWith(".md"));
|
|
269
|
+
let installed = 0;
|
|
270
|
+
|
|
271
|
+
for (const file of files) {
|
|
272
|
+
const dest = path.join(claudeCommandsDir, file);
|
|
273
|
+
|
|
274
|
+
// Only overwrite if file has the managed marker (or doesn't exist)
|
|
275
|
+
if (fs.existsSync(dest)) {
|
|
276
|
+
const existing = fs.readFileSync(dest, "utf-8");
|
|
277
|
+
if (!existing.includes(MARKER)) {
|
|
278
|
+
console.log(` Skipped ${file} (user-modified)`);
|
|
279
|
+
continue;
|
|
280
|
+
}
|
|
281
|
+
}
|
|
282
|
+
|
|
283
|
+
fs.copyFileSync(path.join(pkgCommandsDir, file), dest);
|
|
284
|
+
installed++;
|
|
285
|
+
}
|
|
286
|
+
|
|
287
|
+
if (installed > 0) {
|
|
288
|
+
console.log(` Installed ${installed} slash command(s) → ~/.claude/commands/`);
|
|
289
|
+
console.log(" Available: /oc-checkout, /oc-search, /oc-init, /oc-status");
|
|
290
|
+
} else {
|
|
291
|
+
console.log(" Slash commands already up to date");
|
|
292
|
+
}
|
|
293
|
+
}
|
|
294
|
+
|
|
243
295
|
async function main() {
|
|
244
296
|
console.log("\nopenclew init\n");
|
|
245
297
|
|
|
@@ -290,6 +342,15 @@ async function main() {
|
|
|
290
342
|
console.log("\n7. Index");
|
|
291
343
|
runIndexGenerator();
|
|
292
344
|
|
|
345
|
+
// Step 8: Install Claude Code slash commands
|
|
346
|
+
const noCommands = args.includes("--no-commands");
|
|
347
|
+
console.log("\n8. Slash commands");
|
|
348
|
+
if (noCommands) {
|
|
349
|
+
console.log(" Skipping (--no-commands)");
|
|
350
|
+
} else {
|
|
351
|
+
installSlashCommands();
|
|
352
|
+
}
|
|
353
|
+
|
|
293
354
|
// Done
|
|
294
355
|
console.log("\n─── Ready ───\n");
|
|
295
356
|
if (entryPoint) {
|
package/lib/inject.js
CHANGED
|
@@ -23,6 +23,7 @@ Two types of docs:
|
|
|
23
23
|
Each doc has 3 levels: **L1** (subject + brief — 1 line) → **L2** (summary) → **L3** (full details, only when needed).
|
|
24
24
|
|
|
25
25
|
**Session commands** (user asks in chat, you run):
|
|
26
|
+
- "peek" → \`npx openclew peek\` (list instruction file + all refdocs)
|
|
26
27
|
- "checkout" → \`npx openclew checkout\` (end-of-session summary + log)
|
|
27
28
|
- "new doc about X" → \`npx openclew new "X"\` (create refdoc)
|
|
28
29
|
- "search X" → \`npx openclew search "X"\` (search docs)
|
package/lib/peek.js
ADDED
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* openclew peek — list instruction file + all refdocs (doc/ and project-wide)
|
|
3
|
+
*
|
|
4
|
+
* Discovery tool: shows what knowledge exists before starting work.
|
|
5
|
+
* Zero dependencies — Node 16+ standard library only.
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
const fs = require("fs");
|
|
9
|
+
const path = require("path");
|
|
10
|
+
const { collectDocs } = require("./search");
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* Recursively find _*.md files in a directory tree.
|
|
14
|
+
* Excludes common non-doc directories.
|
|
15
|
+
*
|
|
16
|
+
* @param {string} dir - Directory to scan
|
|
17
|
+
* @param {string[]} excludePaths - Absolute paths to exclude
|
|
18
|
+
* @returns {string[]} Sorted list of absolute file paths
|
|
19
|
+
*/
|
|
20
|
+
function findRefdocsRecursive(dir, excludePaths = []) {
|
|
21
|
+
const results = [];
|
|
22
|
+
const EXCLUDE_DIRS = new Set([
|
|
23
|
+
".git",
|
|
24
|
+
"node_modules",
|
|
25
|
+
"_archive",
|
|
26
|
+
"old",
|
|
27
|
+
".Rproj.user",
|
|
28
|
+
"log",
|
|
29
|
+
"notes",
|
|
30
|
+
"verify_logs",
|
|
31
|
+
]);
|
|
32
|
+
|
|
33
|
+
function walk(current) {
|
|
34
|
+
let entries;
|
|
35
|
+
try {
|
|
36
|
+
entries = fs.readdirSync(current, { withFileTypes: true });
|
|
37
|
+
} catch {
|
|
38
|
+
return;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
for (const entry of entries) {
|
|
42
|
+
const fullPath = path.join(current, entry.name);
|
|
43
|
+
|
|
44
|
+
if (entry.isDirectory()) {
|
|
45
|
+
if (EXCLUDE_DIRS.has(entry.name)) continue;
|
|
46
|
+
if (excludePaths.some((ex) => fullPath === ex || fullPath.startsWith(ex + path.sep))) continue;
|
|
47
|
+
walk(fullPath);
|
|
48
|
+
} else if (
|
|
49
|
+
entry.isFile() &&
|
|
50
|
+
entry.name.startsWith("_") &&
|
|
51
|
+
entry.name.endsWith(".md") &&
|
|
52
|
+
entry.name !== "_INDEX.md"
|
|
53
|
+
) {
|
|
54
|
+
results.push(fullPath);
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
walk(dir);
|
|
60
|
+
return results.sort();
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* Run peek for a project.
|
|
65
|
+
*
|
|
66
|
+
* @param {string} projectRoot - Absolute path to project root
|
|
67
|
+
* @returns {{ instructionFile: string|null, docRefdocs: Array, otherRefdocs: string[] }}
|
|
68
|
+
*/
|
|
69
|
+
function peek(projectRoot) {
|
|
70
|
+
const docDir = path.join(projectRoot, "doc");
|
|
71
|
+
|
|
72
|
+
// Instruction file (CLAUDE.md or AGENTS.md)
|
|
73
|
+
let instructionFile = null;
|
|
74
|
+
for (const name of ["CLAUDE.md", "AGENTS.md"]) {
|
|
75
|
+
const p = path.join(projectRoot, name);
|
|
76
|
+
if (fs.existsSync(p)) {
|
|
77
|
+
instructionFile = p;
|
|
78
|
+
break;
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
// Refdocs in doc/ (with parsed metadata)
|
|
83
|
+
let docRefdocs = [];
|
|
84
|
+
if (fs.existsSync(docDir)) {
|
|
85
|
+
const docs = collectDocs(docDir);
|
|
86
|
+
docRefdocs = docs.filter((d) => d.kind === "refdoc");
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
// Refdocs outside doc/
|
|
90
|
+
const otherRefdocs = findRefdocsRecursive(projectRoot, [docDir]);
|
|
91
|
+
|
|
92
|
+
return { instructionFile, docRefdocs, otherRefdocs };
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
// ── CLI runner ──────────────────────────────────────────────────────
|
|
96
|
+
|
|
97
|
+
function run() {
|
|
98
|
+
const projectRoot = process.cwd();
|
|
99
|
+
const result = peek(projectRoot);
|
|
100
|
+
const projectName = path.basename(projectRoot);
|
|
101
|
+
|
|
102
|
+
console.log(`\n${projectName}\n`);
|
|
103
|
+
|
|
104
|
+
// Instruction file
|
|
105
|
+
if (result.instructionFile) {
|
|
106
|
+
console.log(`Instruction file: ${path.basename(result.instructionFile)}`);
|
|
107
|
+
} else {
|
|
108
|
+
console.log("Instruction file: (none)");
|
|
109
|
+
}
|
|
110
|
+
console.log("");
|
|
111
|
+
|
|
112
|
+
// Doc refdocs
|
|
113
|
+
console.log(`Refdocs in doc/ (${result.docRefdocs.length}):`);
|
|
114
|
+
if (result.docRefdocs.length) {
|
|
115
|
+
for (const doc of result.docRefdocs) {
|
|
116
|
+
const name = path.basename(doc.filepath);
|
|
117
|
+
const subject = doc.meta.subject || "";
|
|
118
|
+
const status = doc.meta.status || "";
|
|
119
|
+
const statusTag = status ? ` [${status}]` : "";
|
|
120
|
+
if (subject) {
|
|
121
|
+
console.log(` ${name} — ${subject}${statusTag}`);
|
|
122
|
+
} else {
|
|
123
|
+
console.log(` ${name}${statusTag}`);
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
} else {
|
|
127
|
+
console.log(" (none)");
|
|
128
|
+
}
|
|
129
|
+
console.log("");
|
|
130
|
+
|
|
131
|
+
// Other refdocs
|
|
132
|
+
if (result.otherRefdocs.length) {
|
|
133
|
+
console.log(`Refdocs outside doc/ (${result.otherRefdocs.length}):`);
|
|
134
|
+
for (const filepath of result.otherRefdocs) {
|
|
135
|
+
const rel = path.relative(projectRoot, filepath);
|
|
136
|
+
console.log(` ${rel}`);
|
|
137
|
+
}
|
|
138
|
+
console.log("");
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
// Subdirectories of doc/
|
|
142
|
+
const docDir = path.join(projectRoot, "doc");
|
|
143
|
+
if (fs.existsSync(docDir)) {
|
|
144
|
+
const SKIP = new Set(["log", "notes", "verify_logs", "_archive", "old"]);
|
|
145
|
+
const subdirs = fs
|
|
146
|
+
.readdirSync(docDir, { withFileTypes: true })
|
|
147
|
+
.filter((e) => e.isDirectory() && !SKIP.has(e.name))
|
|
148
|
+
.map((e) => e.name)
|
|
149
|
+
.sort();
|
|
150
|
+
|
|
151
|
+
if (subdirs.length) {
|
|
152
|
+
console.log("Subdirectories in doc/:");
|
|
153
|
+
for (const d of subdirs) {
|
|
154
|
+
console.log(` ${d}/`);
|
|
155
|
+
}
|
|
156
|
+
console.log("");
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
module.exports = { peek, findRefdocsRecursive };
|
|
162
|
+
|
|
163
|
+
const calledAsPeek = process.argv.includes("peek");
|
|
164
|
+
if (require.main === module || calledAsPeek) {
|
|
165
|
+
run();
|
|
166
|
+
}
|
package/package.json
CHANGED
|
@@ -1,26 +1,17 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "openclew",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"description": "Long Life Memory for LLMs — structured project knowledge for AI agents and humans",
|
|
5
|
-
"license": "
|
|
5
|
+
"license": "Apache-2.0",
|
|
6
6
|
"bin": {
|
|
7
7
|
"openclew": "./bin/openclew.js"
|
|
8
8
|
},
|
|
9
9
|
"files": [
|
|
10
10
|
"bin/",
|
|
11
|
-
"lib/
|
|
12
|
-
"lib/
|
|
13
|
-
"lib/detect.js",
|
|
14
|
-
"lib/index-gen.js",
|
|
15
|
-
"lib/init.js",
|
|
16
|
-
"lib/inject.js",
|
|
17
|
-
"lib/mcp-server.js",
|
|
18
|
-
"lib/new-doc.js",
|
|
19
|
-
"lib/new-log.js",
|
|
20
|
-
"lib/search.js",
|
|
21
|
-
"lib/status.js",
|
|
22
|
-
"lib/templates.js",
|
|
11
|
+
"lib/",
|
|
12
|
+
"!lib/migrate.js",
|
|
23
13
|
"templates/",
|
|
14
|
+
"commands/",
|
|
24
15
|
"skills/",
|
|
25
16
|
"README.md",
|
|
26
17
|
"UPGRADING.md",
|
package/templates/FORMAT.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# openclew document format
|
|
2
2
|
|
|
3
3
|
> SSOT — this file defines the canonical format for all openclew documents.
|
|
4
|
-
> Templates (`refdoc.md`, `log.md`), embedded templates (`lib/templates.js`), and parsers (`
|
|
4
|
+
> Templates (`refdoc.md`, `log.md`), embedded templates (`lib/templates.js`), and parsers (`lib/index-gen.js`, `lib/search.js`) must conform to this spec.
|
|
5
5
|
|
|
6
6
|
---
|
|
7
7
|
|
|
@@ -91,15 +91,16 @@ Between `<!-- L1_START -->` and `<!-- L1_END -->` markers. Two fields only:
|
|
|
91
91
|
<!-- L1_START -->
|
|
92
92
|
**subject:** Short title (< 60 chars)
|
|
93
93
|
|
|
94
|
-
**doc_brief:** 1-2 sentences
|
|
94
|
+
**doc_brief:** 1-2 sentences describing what was done and why, not what the document contains. Must be enough to decide if you need to read further.
|
|
95
95
|
<!-- L1_END -->
|
|
96
96
|
```
|
|
97
97
|
|
|
98
98
|
### Rules
|
|
99
99
|
|
|
100
100
|
- **subject** is the document's title. Keep it short and scannable.
|
|
101
|
-
- **doc_brief** answers: "Should I read this?"
|
|
102
|
-
- Bad: "
|
|
101
|
+
- **doc_brief** answers: "Should I read this?" Describe **what was done and why**, not what the document contains. Quick test: if it starts with "this document describes/presents/contains", it's meta — rewrite with concrete content.
|
|
102
|
+
- Bad (meta): "Configuration and usage of the authentication system for the web application."
|
|
103
|
+
- Bad (process without conclusion): "Investigated memory leak in worker pool. Profiled with pprof, tested several fixes."
|
|
103
104
|
- Good: "Worker pool leaked memory via unclosed response bodies in retry path. Fixed with deferred close. Steady at 120MB under load."
|
|
104
105
|
- Both fields use `**bold_key:**` syntax (not YAML `key: value`).
|
|
105
106
|
- No other fields in L1. All metadata lives on line 1.
|
|
@@ -178,7 +179,7 @@ Between `<!-- L3_START -->` and `<!-- L3_END -->` markers. Starts with `# L3 - D
|
|
|
178
179
|
|
|
179
180
|
## Parser compatibility
|
|
180
181
|
|
|
181
|
-
The `
|
|
182
|
+
The `lib/index-gen.js` parser (via `lib/search.js`) extracts:
|
|
182
183
|
1. **Line 1 metadata**: splits on ` · `, parses `key: value` pairs
|
|
183
184
|
2. **L1 fields**: regex for `**subject:**` and `**doc_brief:**` between L1 markers
|
|
184
185
|
|