Swaru

Help

Your help pages

Your public help pages show your published articles, with your look, your chat and, if you like, your own address.

An admin turns them on under Agents, and sets them up under Help pages. Both are on the Articles page.

How they look

Under Help pages, in Look, set the name in the header, your logo, an accent colour and a style: Clear, Soft or Serif. With no accent colour, they use your chat's.

Your chat on the pages

Your chat shows on your help pages, so someone who can't find an answer can ask without leaving. To turn it off, clear Show your chat on these pages.

Pictures

Paste a picture into the editor, drop one on it, or press Picture. PNG, JPEG, GIF and WebP work, up to 5 MB each and 500 MB in all. You need a plan.

An import brings over the pictures an article shows, so closing your old help centre breaks nothing. One it can't fetch stays a link to where it was.

A picture shows to whoever can read the article it's in: one in a draft or a team-only article stays private. Say what a picture shows when you add it, for people who can't see it.

Writing with blocks

The editor has Visual and Markdown views of the same article. The buttons add these, and you can type them too:

> [!NOTE] A title
> Worth knowing. Also [!TIP], [!WARNING] and [!DANGER].

:::details A question
The answer, hidden until someone opens it.
:::

:::steps
1. First
2. Then
:::

:::cards
- [Billing](/kb/your-company/billing): Plans and invoices
:::

:::tabs
::tab Mac
Press Cmd+R.
::tab Windows
Press Ctrl+R.
:::

Readers can copy a block of code or a whole page. A public article also offers Open in Claude and Open in ChatGPT.

Notes for your team

Each article has Notes, for what to change or check. Only your team sees them. No email goes out for a note.

Your own address

This is on Growth and Scale. It takes a few steps, because you prove the address is yours first:

  1. Under Your own address, enter something like help.yourcompany.com. It needs a part in front of your domain.
  2. Add the TXT record we show you at your DNS provider, and press Check now.
  3. Add the two records we show you next, and press Check now again. The certificate can take up to an hour.

Once it's live, your pages are at that address, and the old getswaru.com/kb/your-company addresses go there too. Keep the records in place: an address that stops proving itself for 7 days is removed. So is a request nobody proves within 7 days, and an address 7 days after your company moves to a plan without one.

Addresses are limited across Swaru, so write to us if yours says it isn't available.

An import remembers where each article was. When your old help centre's address moves here, its links go to the same article, so links out in the world keep working. For any other old link, add it under Old links: the old path, a space, then the article's slug.

Other languages

This is on Growth and Scale. Choose up to 5 languages under Languages. Then press Translate what's missing, or Translate with AI on one article.

The AI writes a draft, and nothing shows until someone publishes it. If it adds a link the article doesn't have, the link is marked [TO CHECK], and that translation can't be published until someone fixes it.

When an article changes, its translations stay up with a note saying so, and it's listed to translate again. Readers choose a language in the header. Your chat and agents read your main articles, and the chat answers in the customer's own language.

Each translation comes from your daily AI budget, up to 100 a day. An article over 20,000 characters is left for a person.

Articles for customers only

This is on Growth and Scale. Set an article's Who can read it to Customers. It leaves your public pages, your agent files and your search. Your customers can reach it two ways:

  • A password: set one under Customers only and share it with them.
  • From your own site: link a signed-in customer to /kb/your-company/signin with their id, email, ts and hash, signed with your identity secret as for signed-in visitors. The time must be within 5 minutes.

Either way they stay signed in for 12 hours. Changing the password or your identity secret signs everyone out.

Your chat answers from these articles only for visitors your own server signed in. Agents read them with a token.

Numbers

Numbers shows the last 30 days: page views, what agents read, searches, searches with no result, and which articles readers rated. Write it beside a search with no result starts that article.

These are counts. There's no cookie, and nothing records who a reader is. Searches are cleaned of email addresses and long numbers, and kept 90 days.

Health

Health lists what's worth a look: links to articles that aren't published, a [TO CHECK] left in, no summary, a long article with no headings, a picture with no words, and an article nobody has changed or checked in 6 months.

While your public pages are on, we also check up to 50 links out of your public articles a day, and list the broken ones.

Docs that keep up with your code

This is on Growth and Scale. Under Code changes, connect a GitHub repository, then add the webhook we show you once. A private repository also needs a read-only token. The connection goes if the person who made it leaves your team.

When a pull request merges into your default branch, or a release goes out, the AI decides whether customers would notice. If they would, it proposes edits to the articles it touches, and they wait in Review. Nothing changes until someone accepts one. Anything it isn't sure of is marked [TO CHECK], and so is any new link, even one from the pull request. An article holding that mark can't go live.

That's up to 20 changes a day and 3 proposed edits a change, from your daily AI budget.

Agents that sign in

Some tools won't take a pasted token. Give them getswaru.com/kb/your-company/team-mcp. They'll open a page where an admin of your company approves them. What they get works like a token: it reads and suggests, and never publishes. It's listed under Agents, where you can revoke it, and it stops when the person who approved it leaves your team or stops being an admin.

Still stuck? Write to hello@getswaru.com.