How it works
Understand how a Google Doc becomes a Sonat document, when your edits reach Sonat, and when readers see them.
You can keep writing in Google Docs and publish with Sonat. The Google Doc stays the place where you write. Sonat keeps a copy of its content, turns it into topics, and publishes that copy to your help center.
The Google Doc is the source
- You write in Google Docs. In the Sonat editor, a Google Doc document opens the doc itself, embedded in the page, so you edit it there with the normal Google Docs tools.
- To work in a full Google Docs window instead, select Edit In Google Doc. The doc opens in a new browser tab.
- Sonat has no separate editor for this content. Topic history and topic settings aren't available for Google Doc topics, because the doc's own version history in Google Docs covers that.
Screenshot: The Sonat editor with a Google Doc document open, showing the embedded Google Doc and the Publish button.
How the doc maps to topics
| In Google Docs | In Sonat |
|---|---|
| The doc's name | The document's title |
| Each tab | One topic, titled with the tab's name |
| A tab nested under another tab | A sub-topic under that topic |
| Tab order | Topic order |
| Deleting a tab | The topic is removed. A published topic stays live until you next publish the document. |
A doc without extra tabs becomes a document with one topic.
When your edits reach Sonat
Sonat copies the latest content from the Google Doc (a sync) at these moments:
- When you return to the Sonat editor window after editing the embedded doc or the doc in another tab.
- When you rename the doc.
- When you preview the document.
- When you publish. Sonat always syncs first, so you publish what's in the doc at that moment.
- When you connect the doc or publish from the Google Docs add-on.
Sonat only updates the topics whose content changed. A sync takes a few seconds for most docs and longer for a doc with many tabs.
When readers see your edits
Readers only see what you publish. A sync updates the draft in Sonat; your help center doesn't change until you select Publish. In a Google Doc document, Publish opens the publish dialog for all changed topics, so one publish sends every edited tab live.
Readers read Sonat's published copy. They don't need access to the Google Doc, and they never see edits you haven't published.
Edits don't flow back to Google Docs
The sync goes one way, from Google Docs to Sonat. Nothing you do in Sonat changes the Google Doc. If a Google Doc topic's content is changed in Sonat by any other route, the next sync replaces it with the doc's content.
Links and videos
- Links: Google wraps links in its own redirect address. Sonat stores the real destination, so links keep working for readers.
- Links to other topics: add them with Add Topic Link in the Google Docs add-on. Sonat turns them into links between topics.
- Videos: add them with Add Video in the add-on. The cover image in your doc becomes a YouTube or Vimeo player in Sonat.
Limits to know about
- Machine translation isn't available for Google Doc topics. Each language is its own Google Doc. See Translate Google Doc topics.
- On the Free plan, topics made from tabs count toward your topic limit. If the doc has more tabs than your plan allows, Sonat stops the publish.
- If Sonat gets no content back for any tab, it skips the sync instead of emptying your topics.
If something goes wrong
My edits in Google Docs don't show in Sonat
Click back into the Sonat editor window, or select Preview. Both sync the doc. If readers don't see the edits, publish the document.
The editor shows "Google Doc Connection Lost"
Sonat can no longer open the doc. This happens when the doc was deleted or its sharing changed. Select Reconnect Google Doc and pick the doc again in the Google file picker.
Publishing fails with "Can not save publish request due to google doc issue"
The sync before publishing didn't finish. Wait a moment and publish again. If it keeps failing, check that the doc still exists and that you can open it in Google Docs.