No proposed edits after a push
You pushed a change to your app, but To review on Changes shows no proposed edit for it. Start on Product › Code, which shows what Docmunk fetched and what each check found. Anyone can select Check now. Owners and admins can change Follow, Check, and Folders.
Check now
On Product › Code, select Check now. “Checked the new app changes” means Docmunk read changes it had not read. “No new app changes” means the code it follows holds nothing it has not read.
Open the newest check
Under App updates, select the newest check. Each commit shows what Docmunk found in it, such as “No app words taken out.” or “Only comments or spacing.”
In To review, an article that shows Drafting is still with the Writer. Its edits show there when the Writer finishes.
Docmunk checks once a day, or only when asked
App updates shows a row such as “2 new changes · Checks at 06:00 UTC” or “Checks when you ask”. Docmunk has your push and waits for the time that Check sets. The default is once a day, at 06:00 UTC.
To check at once, select Check now. To check after each push, an owner or admin sets Check to on every push. See Choose when Docmunk checks your code.
Docmunk waits for pushes to stop
With on every push, once pushes stop for sets how long Docmunk waits after the last push. Each push starts the wait again. App updates shows when the check runs, such as “Checks at 3:40 PM”.
Wait for that time, or select Check now. To check right after each push, an owner or admin sets once pushes stop for to no wait.
The push went to a branch Docmunk does not follow
Docmunk reads only the code that Follow names: your default branch, another branch…, or release tags. A push to any other branch, such as a feature branch, is read when it merges into the followed branch. With release tags, Docmunk reads the newest release tag, so it reads your push when you tag a release.
To follow another branch, an owner or admin changes Follow on Product › Code.
The change is in a folder set to Read or Hide
Docmunk checks only the folders set to Check. On Changes, To review lists the change under a line such as “1 change in the app needs nothing”, with the reason “Only folders you don’t check”. In App updates, the commit says “Nothing the help center covers.”
Docmunk sets some folders to Read by itself, such as one that no screen it knows uses. To check a folder, an owner or admin selects Folders on Product › Code, then Check in that folder's row.
The change shows readers nothing different
Docmunk proposes an edit only when an article says something the change made wrong, or misses a step its reader needs. To review lists each app change that needs nothing, with its reason:
- “Tests only”, “Docs only”, “Build and dependency files only”, “Other languages only”, or “Only comments or spacing”: the change touched no file of the app itself.
- “Not for customers”: customers see and do nothing different.
- “Nothing for the help center”: customers see the change, but no article needs work.
- “No article needs an edit”: Docmunk read the likely articles and found each one right.
On Product › Code, Being written shows “Nothing to change.” when the Writer read an article and found it right.
If no article covers the change, see Write an article. If Docmunk read the change wrong, describe it in your words: in To review, select More (…), then Describe a change.
The push never reached Docmunk
Under the repository's name on Product › Code, “fetched” shows a time before your push, and App updates has no row for it. Check these causes:
- Product › Code names a different repository from the one you pushed to. An owner or admin selects Unlink, then links the right one.
- Docmunk's GitHub App lost access to the repository. Select Check now: “The last clone or fetch failed” shows the error, and the repository's chip says failed. “No new app changes” can show at the same time. Whoever manages your GitHub account gives the App access to the repository again. The next check reads every change since, and App updates marks it Caught up.
- The repository is no longer linked, and Product › Code asks you to link one. Owners and admins can link it again: see Link your code. Docmunk then starts from the newest commit, so describe any change it missed.
A check or the Writer stopped
In App updates, a check marked Stopped shows its error. The next check reads the same changes again. To try at once, select Check now. A check marked Stopped by a restart runs again by itself after Docmunk restarts.
Being written shows Waiting for the Writer when the Writer could not finish an article. It gives the reason, such as “Took too long”, and when it tries again. To try at once, select Try now.
Still stuck
Can I point Docmunk at a change it skipped?
Yes. On Changes, in To review, select More (…), then Describe a change. Enter what changed and select Find. Docmunk finds the commits behind it, reads the articles against it, and proposes edits.
Does Docmunk read changes from before I linked the repository?
No. Docmunk starts at the newest commit when you link the repository, and reads each change pushed after it. To bring in an older change, describe it.
What happens after a force push?
Docmunk checks from the last commit both histories share, and says so in the check's note in App updates. When the histories share no commit, checking starts again from the newest commit.