flowviant 0.28.1 → 0.28.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.
Files changed (2) hide show
  1. package/bin/lib/claude.mjs +54 -21
  2. package/package.json +1 -1
@@ -130,25 +130,62 @@ Ground EVERY claim in files you actually read (Read, Grep, Glob, ls, git in the
130
130
  repo) — never guess.
131
131
 
132
132
  THE HUMAN DOCS — docs/ inside the vault. After the vault pages are current,
133
- COMPILE human documentation FROM them (distill your own vault pages — don't
134
- re-read the whole repo; spot-check a cited file only when something looks off).
135
- Docs are for humans: clear prose, short sections, a reading order. Fixed spine:
136
- - docs/00-start-here.md "Start Here": what this codebase is, how to run it,
137
- the handful of files that matter most, where to go next.
138
- - docs/01-architecture.md the big picture: major pieces, how they fit, data
139
- flow, and a map of the chapters below.
140
- - docs/1N-<chapter>.md — ONE chapter per major subsystem (10, 11, 12 …), YOUR
141
- choice of chapters, derived from the vault's hub pages.
142
- - docs/90-decisions.md — notable design decisions and their why.
143
- - docs/91-glossary.md the project's terms of art.
144
- Docs pages use the same frontmatter files: lists and [[wikilinks]] (they may
145
- link to vault pages); numeric prefixes are the reading order.
133
+ COMPILE professional developer documentation FROM them (distill your own vault
134
+ pages; spot-check a cited file only when something looks off — don't re-read the
135
+ whole repo). These are what a new engineer onboards from and a working engineer
136
+ keeps open: hold them to the standard of Stripe / Google / Microsoft developer
137
+ docs comprehensive, precisely structured, richly cross-linked. Detailed and
138
+ thorough beats short: a reader should be able to work in a subsystem after
139
+ reading its chapter.
140
+
141
+ Fixed spine (numeric prefix = reading order):
142
+ - docs/00-start-here.md — the landing page + MASTER TABLE OF CONTENTS: what the
143
+ product is (2-3 sentences); how to run it locally (prerequisites, install,
144
+ required env, dev server, tests); then a linked table of contents of EVERY
145
+ chapter, each with a one-line description; then 2-3 role-based reading paths
146
+ (e.g. "New to the backend: read 01, then 12, then 14").
147
+ - docs/01-architecture.md — the system at a glance: a Mermaid diagram (a fenced
148
+ code block whose language is mermaid) of the major components and how they
149
+ connect, a component-responsibility table, the primary request/data flows, and
150
+ a link into the chapter for each component.
151
+ - docs/1N-<chapter>.md — ONE chapter per major subsystem (10, 11, 12 …), your
152
+ choice of chapters, derived from the vault's hub pages. Cover every significant
153
+ subsystem.
154
+ - docs/90-decisions.md — notable design decisions, each as context, decision,
155
+ why, and consequences.
156
+ - docs/91-glossary.md — the project's terms of art, alphabetized, each linking to
157
+ the chapter or vault page that defines it.
158
+
159
+ EVERY chapter follows this exact anatomy, in order:
160
+ 1. YAML frontmatter listing the real repo files the chapter draws on.
161
+ 2. A "# Title" heading.
162
+ 3. One or two sentences: what the chapter covers and who should read it.
163
+ 4. A "## Contents" section — an in-page table of contents: a bulleted list
164
+ linking each of the chapter's own "## " sections by anchor. An anchor is the
165
+ heading text lowercased, spaces turned to hyphens, punctuation removed — so
166
+ a section "## How dispatch works" is linked "- [How dispatch works](#how-dispatch-works)".
167
+ 5. The body sections ("## " / "### "), including as relevant: an overview and
168
+ where the subsystem sits in the system; how it works walked step by step
169
+ with REAL code excerpts (fenced and language-tagged) and file citations; a
170
+ Mermaid diagram for any non-trivial flow or sequence; and REFERENCE TABLES
171
+ for the concrete surface — HTTP endpoints (method, path, auth, purpose), key
172
+ functions/types, env/config keys, DB tables/columns — as markdown tables.
173
+ 6. A "## Gotchas" section: the traps, edge cases, invariants, and non-obvious
174
+ constraints.
175
+ 7. A "## See also" section: [[wikilinks]] to the deeper vault pages, plus
176
+ relative links to sibling chapters (e.g. "[Architecture](01-architecture.md)").
177
+
178
+ Cross-link liberally: [[wikilinks]] point to vault pages; relative "NN-name.md"
179
+ links point to sibling chapters; both are clickable in the reader. Keep every
180
+ claim grounded in code you actually read.
146
181
 
147
182
  Full-sweep protocol:
148
183
  1. If the vault already has pages, read index.md + log.md FIRST — update and
149
184
  extend rather than rewrite; delete vault pages whose code no longer exists.
150
185
  2. Explore the repo broadly, then write/refresh pages area by area.
151
- 3. Compile/refresh the docs/ chapters from the finished vault pages.
186
+ 3. Compile/refresh the docs/ chapters from the finished vault pages, following
187
+ the docs spine + per-chapter anatomy above (Contents TOC, reference tables,
188
+ Mermaid diagrams, Gotchas, See also).
152
189
  4. Refresh index.md, append a log.md entry, then output exactly WIKI_DONE on
153
190
  its own line and stop.
154
191
 
@@ -283,9 +320,9 @@ const shortPath = (p, cwd) => {
283
320
  };
284
321
 
285
322
  // Turn one Claude tool_use into a compact activity {kind, label}, or null for
286
- // tools not worth surfacing. `kind:'read'` is what the file counter counts;
287
- // an emit_wiki_node flips the phase to "writing". Used by wiki turns to stream
288
- // exactly which files Claude is touching (daemon console + app cover).
323
+ // tools not worth surfacing. `kind:'read'` is what the file counter counts; a
324
+ // Write/Edit of a vault page is the "writing" signal. Used by wiki turns to
325
+ // stream exactly which files Claude is touching (daemon console + app cover).
289
326
  export function humanizeToolUse(name, input = {}, cwd = '') {
290
327
  switch (name) {
291
328
  case 'Read':
@@ -311,10 +348,6 @@ export function humanizeToolUse(name, input = {}, cwd = '') {
311
348
  case 'Bash':
312
349
  return { kind: 'bash', label: `$ ${String(input.command ?? '').replace(/\s+/g, ' ').slice(0, 60)}` };
313
350
  default:
314
- if (typeof name !== 'string') return null;
315
- if (name.includes('emit_wiki_node')) return { kind: 'write', label: `+ node ${input.id ?? ''}` };
316
- if (name.includes('finish_wiki_generation')) return { kind: 'write', label: 'finalize wiki' };
317
- if (name.includes('list_wiki_nodes')) return { kind: 'mcp', label: 'list wiki nodes' };
318
351
  return null; // other tools: silent
319
352
  }
320
353
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "flowviant",
3
- "version": "0.28.1",
3
+ "version": "0.28.3",
4
4
  "description": "Run your own Claude Code as headless build agents for Flowviant — on your own credentials. Claims dispatched work, opens PRs, captures review evidence, and routes questions back to you.",
5
5
  "type": "module",
6
6
  "bin": {