flowviant 0.28.7 → 0.28.8
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/bin/lib/claude.mjs +33 -33
- package/package.json +1 -1
package/bin/lib/claude.mjs
CHANGED
|
@@ -138,36 +138,37 @@ 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
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
- docs
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
significant
|
|
163
|
-
- docs/90-
|
|
164
|
-
decision, why, and consequences.
|
|
165
|
-
- docs/
|
|
166
|
-
linking to the chapter or vault page that defines it.
|
|
141
|
+
Every chapter declares its sidebar GROUP with a "category:" line in its
|
|
142
|
+
frontmatter — the bold group header it sits under, exactly like the grouped left
|
|
143
|
+
nav in Stripe / HuggingFace docs. Group RELATED chapters under a shared category
|
|
144
|
+
(aim for 2-5 categories total that mirror the codebase's real divisions — e.g.
|
|
145
|
+
"Getting started", "Core runtime", "Workspaces", "Reference"; a category holding a
|
|
146
|
+
single chapter is a smell — merge or regroup). Number the chapters so same-category
|
|
147
|
+
chapters are CONTIGUOUS and the categories flow in reading order. The "# Title" is
|
|
148
|
+
a clean human name — NO number prefix (ordering comes from the filename prefix).
|
|
149
|
+
|
|
150
|
+
Fixed spine (flat docs/ files; numeric prefix = reading order):
|
|
151
|
+
- docs/00-start-here.md (category: "Getting started") — the landing page + MASTER
|
|
152
|
+
TABLE OF CONTENTS: what the product is (2-3 sentences); how to run it locally
|
|
153
|
+
(prerequisites, install, required env, dev server, tests); then a linked table
|
|
154
|
+
of contents of EVERY chapter GROUPED BY CATEGORY, each with a one-line
|
|
155
|
+
description; then 2-3 role-based reading paths (e.g. "New to the backend: read
|
|
156
|
+
Architecture, then Agent fleet, then Data model").
|
|
157
|
+
- docs/01-architecture.md (category: "Getting started") — the system at a glance:
|
|
158
|
+
a Mermaid diagram (a fenced code block whose language is mermaid) of the major
|
|
159
|
+
components and how they connect, a component-responsibility table, the primary
|
|
160
|
+
request/data flows, and a link into the chapter for each component.
|
|
161
|
+
- docs/1N-<chapter>.md — ONE chapter per major subsystem, EACH with its own
|
|
162
|
+
"category:" grouping it with its siblings. Cover every significant subsystem.
|
|
163
|
+
- docs/90-decisions.md (category: "Reference") — notable design decisions, each as
|
|
164
|
+
context, decision, why, and consequences.
|
|
165
|
+
- docs/91-glossary.md (category: "Reference") — the project's terms of art,
|
|
166
|
+
alphabetized, each linking to the chapter or vault page that defines it.
|
|
167
167
|
|
|
168
168
|
EVERY chapter follows this exact anatomy, in order:
|
|
169
|
-
1. YAML frontmatter
|
|
170
|
-
|
|
169
|
+
1. YAML frontmatter: a "category:" group header (see the spine) AND a "files:"
|
|
170
|
+
list of the real repo files the chapter draws on.
|
|
171
|
+
2. A "# Title" heading (a clean name — no leading number).
|
|
171
172
|
3. One or two sentences: what the chapter covers and who should read it.
|
|
172
173
|
4. A "## Contents" section — an in-page table of contents: a bulleted list
|
|
173
174
|
linking each of the chapter's own "## " sections by anchor. An anchor is the
|
|
@@ -181,12 +182,11 @@ EVERY chapter follows this exact anatomy, in order:
|
|
|
181
182
|
functions/types, env/config keys, DB tables/columns — as markdown tables.
|
|
182
183
|
6. A "## Gotchas" section: the traps, edge cases, invariants, and non-obvious
|
|
183
184
|
constraints.
|
|
184
|
-
7. A "## See also" section: [[wikilinks]] to the deeper vault pages, plus
|
|
185
|
-
to sibling chapters
|
|
185
|
+
7. A "## See also" section: [[wikilinks]] to the deeper vault pages, plus
|
|
186
|
+
relative links to sibling chapters (e.g. "[Architecture](01-architecture.md)").
|
|
186
187
|
|
|
187
|
-
Cross-link liberally: [[wikilinks]] point to vault pages;
|
|
188
|
-
|
|
189
|
-
— you needn't spell the folder path. Both are clickable in the reader. Keep every
|
|
188
|
+
Cross-link liberally: [[wikilinks]] point to vault pages; relative "NN-name.md"
|
|
189
|
+
links point to sibling chapters; both are clickable in the reader. Keep every
|
|
190
190
|
claim grounded in code you actually read.
|
|
191
191
|
|
|
192
192
|
Full-sweep protocol:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "flowviant",
|
|
3
|
-
"version": "0.28.
|
|
3
|
+
"version": "0.28.8",
|
|
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": {
|