Browse topics · Guides

Guides

Edit Guide project files

Make direct JSON edits, reorder or remove content, and preserve rich formatting and file identity.

Local Guide Project files let you edit accepted Guide content using ordinary file saves. Keep the eligible desktop Guide editor open while you work.

Make a direct edit

  1. Select Folder in the Guide editor.
  2. Read the generated editing and format documentation.
  3. Locate the relevant source file and read its current contents.
  4. Change the intended value inside data, preserving unrelated values.
  5. Save valid JSON and confirm the change appears in CareMap.
  6. Inspect the project status icon if acceptance is delayed.

Use strict JSON: comments and trailing commas are invalid. Keep the exported id, kind, part, format, and sourceVersion headers. Do not invent a newer sourceVersion to bypass a conflict.

ChangeFile or value to inspect
Guide nameguide.json, data.name
Block text, prompt, caption, or flashcard answerThe block's content.json
Response method settingsThe method's config.json
Block orderThe page's blocks.json ordered data.ids
Response method orderThe Field's methods.json ordered data.ids

Directory names encode stable IDs, not display names. Renaming a Guide, page, or block does not require renaming its directory. Follow membership IDs to find children.

Remove content through its parent

To remove a block, remove its ID from the owning page's blocks.json data.ids and save that file. To remove only one response method, remove its ID from the Field's methods.json.

Removing a Field block also removes its methods from the Guide. CareMap cleans up the accepted removed content's managed files. Deleting a still-referenced JSON file or directory instead produces a missing-file error.

Removing a page or sequence may also require fixing routes or the start sequence. Use a batch for dependent changes.

Preserve rich text

Formatted block content can live in data.richText, with separate documents for text, prompt, caption, or flashcard answer. Preserve that native content when changing wording that includes images, sizing, captions, or alignment.

Changing only the corresponding Markdown string explicitly replaces that field's rich content with converted Markdown. Rich formatting can be lost. An explicitly changed native document takes precedence over its accompanying Markdown projection.

Use imported asset IDs for images; a local path or temporary download URL is not a durable Guide image reference.

Resolve rejected source

Invalid or conflicting source stays available for correction while the accepted Guide remains usable. Unrelated edits can continue synchronizing. Save or cancel any overlapping visual-editor draft, then inspect project recovery and conflicts.

New records require all their source parts and parent membership. Use the generated scaffolding and batch workflow rather than copying an existing record's identity.