Fleet Schemas ↑↓ move within a pane · ←→ move between panes · Enter opens · Esc backs out
WritingIndex 25 fields

research-writing/WritingIndex

groups non-empty list of object
Taxonomy areas that collect related research questions, each under a section.
required
id string matching /^[a-z0-9]+(-[a-z0-9]+)*$/
Kebab-case group id; the key every question names in its group field.
required
name non-empty string
Area heading shown on the writing page and in the agent context file; the taxonomy area within the section.
required
section non-empty string
Top-level taxonomy section (Empirical, Theory, Governance and Strategy, Sociotechnical, My path) this group sits under; sections render in the order their groups first appear. A group whose name equals its section renders no separate area sub-heading.
required
order integer
Display position; groups render in ascending order.
required
questions non-empty list of object
Research questions, in display order within each group.
required
id string matching /^[a-z0-9]+(-[a-z0-9]+)*$/
Kebab-case question id; also the page folder name, q/<id>/.
required
text non-empty string
The research question, as the page and the agent context file show it.
required
group non-empty string
The groups[].id this question sits under.
required
suggestedBest non-empty string
Agent-chosen piece id agents load for this question until the user picks one; the piece must name this question.
required
best non-empty string
Piece id the user picked as best for this question. Set only on the user's word; overrides suggestedBest.
pieces non-empty list of object
One row per piece of the user's writing. A piece points at a file and headings and never holds the user's text.
required
id string matching /^[a-z0-9]+(-[a-z0-9]+)*$/
Stable piece id that questions name in best and suggestedBest. Opaque; never renamed once set.
required
file non-empty string
Source file, relative to ~/mnt/mdr/skills.
required
sections non-empty list of non-empty string
Headings whose sections are kept, in this order; the single entry "-" keeps the whole file. Each section ends at the next heading of the same or higher level.
required
fromLine non-empty string
Keep the section from the first line beginning with this text.
exclude list of non-empty string
Subsection headings to drop from the kept sections.
dropLines list of non-empty string
Drop every line beginning with one of these texts.
questionFrom non-empty string
Heading of a different section to take the form question label from, when the piece's own first section carries none. The label is that section's quoted lines, or its plain text when it has none; it is never the user's answer.
date string matching /^\d{4}-\d{2}-\d{2}$/
When the user wrote it, best known, as a quoted YYYY-MM-DD string. The file date is not evidence: a file can hold text written earlier.
required
title non-empty string
Short label for this piece; the text before " - " names where it was written.
required
draft boolean
True while the user has not finished this piece; set only on the user's word. The writing page leaves it out and the agent context file labels it a draft.
questions list of object
Research questions this piece substantively answers, main question first; empty when it answers none.
required
id non-empty string
A questions[].id this piece answers.
required
reason non-empty string
Words quoted from the piece that show it answers the question; must appear word for word in the extracted piece.
required

Checks

  • idsAreUnique - two rows with one id would merge pages or make a best pick ambiguous
  • questionsNameKnownGroups - a question naming no group would be dropped from every output
  • piecesNameKnownQuestions - a piece naming no question would never be listed under it

Defects

No defects in the 1 record checked.

Where it lives

Bound byresearch-writing
Declared in~/mnt/mdr/skills/research-writing/assets/schemas/writing-index.ts
BindingwritingIndexDataStore
Directory~/mnt/mdr/skills/research-writing/assets
Fileswriting-index.yml
Referenced aswriting-index