Guides
Use a Local Guide Project
Open a live desktop project folder and edit Guide source files alongside the visual editor.
A Local Guide Project exposes an open Guide as editable files on your computer. Valid file saves can update the same Guide shown in the desktop editor.
This requires the CareMap desktop app, Guide edit permission, and the owning workspace's Content Use, Content Authoring, and Codex Guide Authoring capabilities. Your personal administrator status or another workspace's License does not establish this Guide's eligibility.
Open the folder
- In the desktop app, open Library and Edit an eligible Guide.
- Wait for its project controls to become ready.
- Select Folder to open the local project directory.
- Open its generated documentation and source in your preferred text editor.
- Save a small supported change and confirm that the visual Guide updates.
- Select the project status icon to inspect Local Guide Project details.
The directory is tied to your account, environment, and Guide. Moving the Guide between folders does not turn it into a different project, although access is checked against its current owner.
Keep the CareMap Guide editor open while working. Browser playback and mobile editing do not provide this local folder workflow.
Understand the status
| Status | Meaning |
|---|---|
| Project synchronized | No currently reported project work needs attention |
| Project syncing | Initialization or source changes are pending |
| Media import pending | An image, audio, or video import is still running |
| Project waiting for connection | Synchronization needs connectivity |
| Project needs attention | Inspect a diagnostic, conflict, or preserved proposal |
| Project recovery available | Prior session material is available for review |
| Project session ended | This project session is closed |
The status button opens details even when there is an error. Open folder and Retry synchronization are available there when appropriate.
Saving bytes in your text editor does not itself prove CareMap accepted them. Invalid JSON, missing references, conflicting edits, unsaved visual-editor drafts, and media dependencies can delay or reject synchronization.
Choose the right editing tool
Ordinary file edits need no extra software beyond a text editor. Read project files for naming, content, reordering, and removal.
The generated optional SDK supports creating records, dependent batches, and media imports. Its scripts require Node.js 18 or later; no package installation is needed for the generated SDK. See project batches.
When controls are missing or the session ends
Check that you are using the desktop app and editing an active Guide with the required workspace capabilities. Access loss can end the project session.
Closing the editor removes CareMap-managed working files. Your separate notes, scripts, and local media originals are preserved. Reopening materializes the accepted Guide, while unaccepted proposals are offered separately for recovery.