Create and batch Guide project changes

The optional project SDK groups dependent file changes so CareMap can validate them together. Use it for new records, moves between parents, or changes that also alter routing references.

Keep the licensed desktop Guide editor open. The generated SDK runs with Node.js 18 or later and does not require installing packages. Ordinary single-file edits, reorders, and removals can use direct saves without an SDK connection or preliminary compile.

Make a dependent change

1. Open Folder and read the generated SDK guide and relevant example.
2. Identify every source file the change affects, including parent membership and dependent routing files.
3. Begin a batch for those files and wait for the hold to be acknowledged.
4. Edit the held files. Use scaffolding for new identities and all required parts.
5. Compile the group if you want to inspect it before submission.
6. Commit the batch, then wait for accepted synchronization and inspect CareMap.

For example, the generated command tool supports:

node tools/caremap.mjs batch begin my-edit guide.json guide/navigation.json
node tools/caremap.mjs compile guide.json guide/navigation.json
node tools/caremap.mjs batch commit my-edit
node tools/caremap.mjs wait

This example lists a batch and its checks; make your intended edits between begin and compile. Use the actual files required by your task.

Create complete records

Scaffolding returns a new identity and source files. It does not itself write files or add the record to the Guide. Write all required parts, then include the new ID in its parent's ordered membership list inside the batch.

A new sequence needs at least one page. Unreferenced new source remains staging material. Moving a record updates both parents' membership files; its identity-based directory stays the same.

Generated examples can add content to the Guide. Read them before running them.

Understand hold, commit, and cancel

A held batch prevents its listed files from entering ordinary synchronization. A failed editing callback can leave that hold in place for correction.

Commit queues the group; it does not prove acceptance. Compilation checks the source without submitting it. The SDK's wait and diagnostics tools help identify invalid source, conflicts, pending files, or blocked drafts.

Cancel releases the hold; it does not undo file edits. Released files resume ordinary synchronization. Correct an unwanted partial change before releasing it, or use the appropriate conflict-resolution workflow.

The generated preview request does not open playback or change the editor's mode. Use CareMap's normal Preview control when you want to test playback.

If a request times out

A timeout leaves the result uncertain. Inspect the existing batch, files, and project status before repeating a structural operation. It does not by itself mean the editor closed. Resolve holds and diagnostics through project recovery.