Docs updates

Docs that don't fall behind the code.

When a release adds something your docs don't cover, DevRelay drafts the missing section for the page it belongs on. Approve it and DevRelay opens a pull request on your docs repo for you to merge.

Start free See pricing
tidydesk/app · Release with PR #318GroundingRelease statusBrand
tidydesk.com/docs/replying
@@ -0,0 +1,11 @@
+## Send later for replies
+
+If you don’t want to send a reply right away, schedule it from the reply composer. Tidydesk sends it at the chosen time, so your team can plan a reply without leaving the conversation.
+
+1. Open a conversation and type your reply in the composer.
+2. Choose **Send later** instead of **Send**.
+3. Choose **Tomorrow morning**, **Monday morning**, or a custom date and time.
+
+**Tomorrow morning** and **Monday morning** are both scheduled for 8:00 AM. Replies are sent in the customer’s time zone when it’s known, or the assignee’s time zone otherwise. A toast confirms when the reply is scheduled. Scheduled replies appear in the conversation with a clock icon. You can edit or cancel one until it’s sent.
+
+If the customer replies before the scheduled reply is sent, the scheduled reply is paused and the assignee is notified.

The section goes under the help page research found. Once approved, DevRelay adds it to that page in your docs repo on a new branch and opens a pull request for you to merge.

Unedited draft · Tidydesk sample workspace
Only when needed
no patch if a guide exists
Real steps
from the pull request
Pull request
you review and merge
Why docs drift

The code changed on Tuesday. The docs still describe last quarter.

Docs rarely go wrong in one big mistake. They fall behind one release at a time.

Docs aren't in the pull request

The change gets reviewed, merged and released. The docs page that should mention it isn't part of the diff, so nobody notices it's missing.

Users ask for what exists

Issues and support threads ask for features you shipped months ago, because the docs never said so.

Examples stop working

A signature changes, the guide still shows the old call, and the first thing a new user runs is an error.

How it works

From release to the docs section it needs.

DevRelay only drafts a docs update when the docs are actually missing something.

01

Reads your docs

Add your docs site as a knowledge source and DevRelay crawls it, splits it into passages and indexes them. That index is what it checks each release against, and what it quotes when it writes.
Docs already contain a guide        → no patch
Docs lack a section for Send later  → docs_patch
02

Asks whether the docs already cover it

For every released change, the classifier checks the change against your docs. If a guide already covers it, there's no patch. If the change adds a feature or setting your docs don't mention, a docs update goes on the plan.
03

Drafts the missing section

A heading, a short explanation written from the change, the steps in the exact button names, and the code example from the pull request when it has one. It targets the docs page research found and comes as a diff, so you can see exactly what would be added.
04

Checks it like any other draft

Feature names, settings and claims have to appear in the evidence, and nothing about a beta feature gets called GA. Go code in a draft is parsed too, so broken syntax fails before you see it.
05

Adds a tutorial when there's material for one

For a high-priority new capability your docs don't cover, DevRelay also drafts a step-by-step tutorial, but only when the pull request has enough to work from: an example or real detail. Otherwise it says so and skips it.
approved                       docs_patch
branch                         devrelay/docs-…
pull request opened            you merge
06

Approve it and a pull request opens

Pick your docs repo and folder once in Sources. When you approve the update, DevRelay commits it to a new devrelay/docs branch and opens a pull request. You review and merge it on GitHub; DevRelay never merges or pushes to your main branch.
Knowledge

Grounded in your docs, your site and your brand.

The brain holds what DevRelay knows about your company: the sources it crawled, your product facts and your voice. Docs drafts quote it; they don't guess.

app.devrelay.so/brain
DevRelay brain page showing the company profile and knowledge sources
FAQ

Questions about docs updates.

01Does it open a pull request on our docs repo?

Yes, on the DevRelay plan. An admin picks the docs repo and folder in Sources; approving a docs update commits it to a new branch and opens a pull request into your default branch. The GitHub App needs write access to contents and pull requests for that. Without it, or without a docs repo set, the update exports as Markdown. On the free plan you can see and review every draft.

02Which docs platforms does it work with?

Any public docs site that serves its pages as HTML, which most static-site and hosted docs tools do. DevRelay doesn't run JavaScript when it crawls, so pages that only render in the browser can't be read. The output is Markdown, so pull requests fit docs kept as Markdown files in a GitHub repo.

03Can it read private or internal docs?

No. The crawler only fetches public http and https pages and refuses private, loopback and link-local addresses.

04How does it decide the docs are missing something?

A classifier compares the released change with what it found in your docs. When it's confident a guide already exists, no patch is drafted. When the change adds a feature or setting that isn't documented, one is.

05Where does the code example come from?

From the pull request that shipped the change, when it has one. The writer takes code from the evidence rather than making it up, and Go examples are parsed as part of the checks. Many product changes need no code at all: the section is steps and button names instead.

06Will it rewrite pages that already exist?

No. It drafts the missing section for a new change. Rewriting or restructuring existing pages is up to you.

GuideDocs drift: how to keep documentation in sync with your codeRead more ProductIdeas: how-tos and tips from your docs, for the weeks you don't shipRead more ProductLaunch posts: X and LinkedIn posts for every releaseRead more

Ship the feature and the docs for it in the same week.

Connect a repo and your docs site. The next release that outgrows your docs comes with the missing section, drafted and checked.

Start free See pricing

No credit card · Nothing posts without your approval