List everything wrong in the folder
folio_healthLists all problems in a served folder or document after edits—broken links, includes, figure/data contradictions, failed queries, unreadable data, and broken declarations—so you can see what to fix.
Instructions
List every problem in the served folder, or with path only in that document or under that folder: links to files, headings or blocks not there, includes that find nothing and include loops, figures their data contradicts, diagrams, charts and queries that fail, data that cannot be read, and declarations, fields, rules and saved views a document breaks. Use it after editing documents, given the path of what you edited, to answer which figures disagree with their data, or to find what to fix; for one block's figures in detail use folio_provenance, and for what needs the reader, ranked, folio_needs. It reveals nothing of the reader's reading, and waits while health is being checked. Answers {ready, problems: [{kind: figure, link, include, loop, diagram, chart, query, data, declaration, field, rule or view, path, line, block, severity: error or warning - absent for a problem that is neither, what, anchor: the element to land on, opens: the document showing it when another, occurrence: which of a rule's alike rows}], version: the same while the problems are}; ready false means Folio is still reading the folder, so ask again shortly. A list cut to fit one answer adds omitted, the entries each list left out, and narrow, how to ask for less.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | A document, relative to the served folder or absolute under it, such as notes/plan.md, or a folder, such as notes/; omit for the whole folder |