@colony2/cortex 0.0.7 → 0.0.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/README.md +18 -2
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -9,6 +9,20 @@ Cortex connects to a remote [JobDB](https://github.com/colony-2/jobdb) server.
9
9
  Run c2j workers separately against the same JobDB. Projects in the UI are JobDB
10
10
  tenants; cells are the current Git repository and its c2j-configured dependents.
11
11
 
12
+ ## Document reviews
13
+
14
+ The **Reviews** navigation item lists pending input forms marked `kind: review`.
15
+ Reviews are excluded from **Pending Inputs**, and each section has its own count.
16
+ Open a review to switch between its documents, view Markdown rendered or as its
17
+ exact source, and answer the recipe's questions. Original documents are read only;
18
+ file-upload questions attach separate response documents (one file per question,
19
+ 32 MiB total HTTP request limit). Other document formats can be downloaded.
20
+
21
+ Responses use c2j's request identity, validation, and receipts. A job's story links
22
+ to its review. Completed reviews leave the pending list; historical review lookup
23
+ is not available yet. See the [recipe author guide](GUIDE-Review-Recipe-Authors.md)
24
+ and [c2j API follow-up requirements](docs/C2J-Review-API-Requirements.md).
25
+
12
26
  ## Install and run
13
27
 
14
28
  Releases provide Linux and macOS binaries for x86_64 and ARM64. Install through
@@ -144,7 +158,9 @@ submission, stories, tenants, cells, and input events. The production tests use
144
158
  HTTP JobDB backed by temporary SQLite storage.
145
159
 
146
160
  The recipe-input tests build the pinned c2j command and execute real Git-backed
147
- recipes with single-question and multi-field input requests. They submit jobs
161
+ recipes with single-question and multi-field input requests, plus document
162
+ reviews. The review test covers rendered/source Markdown, multiple documents,
163
+ stale and invalid responses, separate response attachments, and receipts. They submit jobs
148
164
  through the browser, observe pending requests in a second tab over SSE, check
149
165
  required fields and page reloads, submit answers while the worker is stopped,
150
166
  and restart it to verify the exact recipe output and completed story. They also
@@ -156,7 +172,7 @@ mocks are used in these tests. Worker logs and recipe outcomes are attached to
156
172
  the Playwright report in `web/app/playwright-report`.
157
173
 
158
174
  The timeout regression also runs against the real worker. It currently records
159
- an **expected failure**: with c2j v0.0.53 / JobDB v0.0.19, an unanswered external
175
+ an **expected failure**: with the pinned c2j / JobDB versions, an unanswered external
160
176
  input task remains pending past its recipe deadline. Step deadlines have the
161
177
  same limitation. The test first verifies that the prompt appears, then marks
162
178
  only a confirmed still-pending outcome after the deadline as expected; setup
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@colony2/cortex",
3
- "version": "0.0.7",
3
+ "version": "0.0.10",
4
4
  "description": "Web interface for c2j recipe jobs",
5
5
  "license": "UNLICENSED",
6
6
  "homepage": "https://github.com/colony-2/cortex",