How to Update Docs

How to Update Documentation

Storeharmony’s documentation is updated through a manual, approval‑based email workflow. This ensures every change is reviewed before going live.

📬 Email Address

Send update instructions to:

documentation@storeharmony.com

The inbox is monitored only when explicitly requested—no automatic polling.

📝 Email Format

Use this template in the email body:

LINK: The link to the section that needs to change
ACTION: replace | update | amend | delete
UPDATE: New content (plain text) or a Google Doc link

Examples

1. Replace a paragraph

LINK: https://apps.storeharmony.com/docs/products/pawpaw
ACTION: replace
UPDATE: "AI‑powered form builder that lets you create surveys" → "AI‑powered form builder that turns natural language into professional forms"

2. Delete a section

LINK: /docs/products/inventory-guide
ACTION: delete
UPDATE: Remove the paragraph about legacy barcode scanners

3. Full file replacement
Attach the updated .md file to the email. The attached file will replace the existing one.

4. Reference a Google Doc

LINK: products/shopon.md
ACTION: update
UPDATE: https://docs.google.com/document/d/abc123/edit

The Google Doc content will be fetched manually when the change is approved.

The LINK: field accepts several formats:

Format Example Maps to
Full URL https://apps.storeharmony.com/docs/products/pawpaw products/pawpaw.md
Path /docs/products/inventory-guide products/inventory-guide.md
Page ID inventory-guide products/inventory-guide.md
File path products/storeharmony-erp.md products/storeharmony-erp.md

The mapping is based on site.json; unknown links will be treated as relative paths inside /var/www/docs/content/.

⚙️ Supported Actions

Action Description
replace Swap specific text (OLD → NEW) or replace the entire file
update / amend Treated as replace
delete Remove a block of text or delete the entire file
append / prepend Add content at the end or beginning of a file (legacy format)

👁️ Approval Workflow

  1. You send an email with update instructions.
  2. You tell the AI assistant: “Check the documentation email for updates.”
  3. Assistant fetches the email, parses instructions, and shows a diff for each proposed change.
  4. You review the diff and approve/reject each change.
  5. Assistant applies only the approved changes, creates backups (.bak‑YYYYMMDDHHMMSS), and marks the email as processed.

No changes are applied automatically. Every update requires explicit approval.

🛡️ Safety & Backups

  • Original files are backed up before any edit.
  • Processed email IDs are tracked to avoid re‑processing.
  • Credentials are stored securely in the assistant’s workspace (TOOLS.md).
  • The script (check‑docs‑email.py) is open for review in /root/.openclaw/workspace/scripts/.

🚀 Quick Start

  1. Send a test email to documentation@storeharmony.com using the template above.
  2. Tell the assistant: “Check the documentation email for updates.”
  3. Review the diff and approve the change.

This guide is itself part of the documentation and can be updated via the same workflow.