flowviant 0.28.7 → 0.28.9

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 +42 -33
  2. package/package.json +1 -1
@@ -138,36 +138,46 @@ docs — comprehensive, precisely structured, richly cross-linked. Detailed and
138
138
  thorough beats short: a reader should be able to work in a subsystem after
139
139
  reading its chapter.
140
140
 
141
- Organize the chapters into CATEGORY FOLDERS: docs/<NN>-<category>/<MM>-<chapter>.md.
142
- The folder name (minus its numeric prefix, hyphens spaces) becomes the sidebar's
143
- bold GROUP HEADER exactly like the grouped left nav in Stripe / HuggingFace docs.
144
- Numeric prefixes on BOTH the folder and the file set reading order.
145
-
146
- Fixed spine:
147
- - docs/00-overview/00-start-here.md the landing page + MASTER TABLE OF CONTENTS:
148
- what the product is (2-3 sentences); how to run it locally (prerequisites,
149
- install, required env, dev server, tests); then a linked table of contents of
150
- EVERY chapter GROUPED BY CATEGORY, each with a one-line description; then 2-3
151
- role-based reading paths (e.g. "New to the backend: read Architecture, then
152
- Agent fleet, then Data model").
153
- - docs/00-overview/01-architecture.md the system at a glance: a Mermaid diagram
154
- (a fenced code block whose language is mermaid) of the major components and how
155
- they connect, a component-responsibility table, the primary request/data flows,
156
- and a link into the chapter for each component.
157
- - docs/<NN>-<category>/<MM>-<chapter>.mdthe subsystem chapters, sorted into a
158
- FEW meaningful categories (aim for 2-5 folders) that mirror the codebase's real
159
- divisions e.g. docs/10-core-runtime/, docs/20-api-and-data/, docs/30-frontend/.
160
- Each folder groups the RELATED chapters (a category holding a single chapter is a
161
- smell merge or regroup). One chapter per major subsystem; cover every
162
- significant one.
163
- - docs/90-reference/00-decisions.md notable design decisions, each as context,
164
- decision, why, and consequences.
165
- - docs/90-reference/01-glossary.md the project's terms of art, alphabetized, each
166
- linking to the chapter or vault page that defines it.
141
+ MANDATORY every compile normalize BOTH new AND EXISTING chapters (do NOT
142
+ leave an existing chapter untouched just because its prose is already current;
143
+ its frontmatter and title are part of the chapter and must comply):
144
+ Frontmatter MUST contain a "category:" line. If a chapter lacks one, ADD it now.
145
+ • The "# Title" MUST be a clean name with NO leading number — "Architecture",
146
+ never "01 — Architecture". If a title carries a number, REWRITE it clean now.
147
+ Open every existing docs/ chapter and FIX any that violate these two rules on
148
+ EVERY run. The sidebar grouping + clean titles depend on it; it is not skippable.
149
+
150
+ Every chapter declares its sidebar GROUP with a "category:" line in its
151
+ frontmatter the bold group header it sits under, exactly like the grouped left
152
+ nav in Stripe / HuggingFace docs. Group RELATED chapters under a shared category
153
+ (aim for 2-5 categories total that mirror the codebase's real divisions — e.g.
154
+ "Getting started", "Core runtime", "Workspaces", "Reference"; a category holding a
155
+ single chapter is a smell merge or regroup). Number the chapters so same-category
156
+ chapters are CONTIGUOUS and the categories flow in reading order. The "# Title" is
157
+ a clean human name NO number prefix (ordering comes from the filename prefix).
158
+
159
+ Fixed spine (flat docs/ files; numeric prefix = reading order):
160
+ - docs/00-start-here.md (category: "Getting started") the landing page + MASTER
161
+ TABLE OF CONTENTS: what the product is (2-3 sentences); how to run it locally
162
+ (prerequisites, install, required env, dev server, tests); then a linked table
163
+ of contents of EVERY chapter GROUPED BY CATEGORY, each with a one-line
164
+ description; then 2-3 role-based reading paths (e.g. "New to the backend: read
165
+ Architecture, then Agent fleet, then Data model").
166
+ - docs/01-architecture.md (category: "Getting started") the system at a glance:
167
+ a Mermaid diagram (a fenced code block whose language is mermaid) of the major
168
+ components and how they connect, a component-responsibility table, the primary
169
+ request/data flows, and a link into the chapter for each component.
170
+ - docs/1N-<chapter>.md — ONE chapter per major subsystem, EACH with its own
171
+ "category:" grouping it with its siblings. Cover every significant subsystem.
172
+ - docs/90-decisions.md (category: "Reference") — notable design decisions, each as
173
+ context, decision, why, and consequences.
174
+ - docs/91-glossary.md (category: "Reference") — the project's terms of art,
175
+ alphabetized, each linking to the chapter or vault page that defines it.
167
176
 
168
177
  EVERY chapter follows this exact anatomy, in order:
169
- 1. YAML frontmatter listing the real repo files the chapter draws on.
170
- 2. A "# Title" heading.
178
+ 1. YAML frontmatter: a "category:" group header (see the spine) AND a "files:"
179
+ list of the real repo files the chapter draws on.
180
+ 2. A "# Title" heading (a clean name — no leading number).
171
181
  3. One or two sentences: what the chapter covers and who should read it.
172
182
  4. A "## Contents" section — an in-page table of contents: a bulleted list
173
183
  linking each of the chapter's own "## " sections by anchor. An anchor is the
@@ -181,12 +191,11 @@ EVERY chapter follows this exact anatomy, in order:
181
191
  functions/types, env/config keys, DB tables/columns — as markdown tables.
182
192
  6. A "## Gotchas" section: the traps, edge cases, invariants, and non-obvious
183
193
  constraints.
184
- 7. A "## See also" section: [[wikilinks]] to the deeper vault pages, plus links
185
- to sibling chapters by BASENAME (e.g. "[Architecture](01-architecture.md)").
194
+ 7. A "## See also" section: [[wikilinks]] to the deeper vault pages, plus
195
+ relative links to sibling chapters (e.g. "[Architecture](01-architecture.md)").
186
196
 
187
- Cross-link liberally: [[wikilinks]] point to vault pages; sibling-chapter links by
188
- BASENAME ("MM-name.md") resolve no matter which category folder the target sits in
189
- — you needn't spell the folder path. Both are clickable in the reader. Keep every
197
+ Cross-link liberally: [[wikilinks]] point to vault pages; relative "NN-name.md"
198
+ links point to sibling chapters; both are clickable in the reader. Keep every
190
199
  claim grounded in code you actually read.
191
200
 
192
201
  Full-sweep protocol:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "flowviant",
3
- "version": "0.28.7",
3
+ "version": "0.28.9",
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": {