flowviant 0.28.8 → 0.28.10

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 +36 -15
  2. package/package.json +1 -1
@@ -138,32 +138,53 @@ 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
- 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).
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 page declares its sidebar GROUP with a "category:" line in its frontmatter
151
+ — the group header it sits under, like the grouped left nav in HuggingFace docs.
152
+ The category may be TWO levels, "Top group / Sub-group", to add HuggingFace's
153
+ second nav tier: use the sub-level to break a LARGE top group into coherent
154
+ sub-groups (e.g. "Workspaces / Fundraising", "Workspaces / Finance & budget"); a
155
+ single level ("Reference") is fine for small groups. Aim for 3-6 top groups that
156
+ mirror the codebase's real divisions; a group OR sub-group holding a single page
157
+ is a smell — merge or regroup. Keep same-group pages CONTIGUOUS by filename number
158
+ so reading order also orders the nav. The "# Title" is a clean human name — NO
159
+ number prefix (ordering comes from the filename prefix).
160
+
161
+ Prefer MANY FOCUSED pages over a few giant chapters — HuggingFace granularity:
162
+ ONE page per coherent topic, not one page per whole subsystem. If a subsystem is
163
+ large, SPLIT it into several pages (its overview, its data model, its API, its
164
+ key flows), each its own docs/NN-page.md with its own category, so the left nav
165
+ is a fine-grained tree of pages and each page is focused enough to read in one
166
+ sitting. The in-page "## " sections are the right-hand on-this-page rail — the
167
+ left nav is pages, so when a chapter grows more than a handful of "## " sections,
168
+ that is the signal to split it into separate pages.
149
169
 
150
170
  Fixed spine (flat docs/ files; numeric prefix = reading order):
151
171
  - docs/00-start-here.md (category: "Getting started") — the landing page + MASTER
152
172
  TABLE OF CONTENTS: what the product is (2-3 sentences); how to run it locally
153
173
  (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").
174
+ of contents of EVERY page GROUPED BY CATEGORY, each with a one-line description;
175
+ then 2-3 role-based reading paths (e.g. "New to the backend: read Architecture,
176
+ then Agent fleet, then Data model").
157
177
  - docs/01-architecture.md (category: "Getting started") — the system at a glance:
158
178
  a Mermaid diagram (a fenced code block whose language is mermaid) of the major
159
179
  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.
180
+ request/data flows, and a link into the page for each component.
181
+ - docs/NN-<page>.md — the subsystem PAGES: many focused pages (split large
182
+ subsystems into several), EACH with its own 1- or 2-level "category:" placing it
183
+ in the nav. Cover every significant part of the system.
163
184
  - docs/90-decisions.md (category: "Reference") — notable design decisions, each as
164
185
  context, decision, why, and consequences.
165
186
  - 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.
187
+ alphabetized, each linking to the page that defines it.
167
188
 
168
189
  EVERY chapter follows this exact anatomy, in order:
169
190
  1. YAML frontmatter: a "category:" group header (see the spine) AND a "files:"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "flowviant",
3
- "version": "0.28.8",
3
+ "version": "0.28.10",
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": {