Choose when Docmunk checks your code
Docmunk reads each change to your code and proposes edits to the articles it makes wrong. These settings say which code it reads, and when.
Before you start
- Your code is linked. See Link your code.
- Owners and admins can change these settings. Anyone can select Check now.
Set what Docmunk reads and when
Go to Product › Code. The settings sit under the repository’s name:
- Follow: the code Docmunk reads: your default branch, another branch… you name, or release tags.
- Check: when Docmunk checks: on every push, once a day (the default), or only when asked. A daily check runs at the time you set, in UTC.
- once pushes stop for: with on every push, how long Docmunk waits after the last push: no wait, 10 min (the default), 30 min, or 1 hour.
- Folders: for each folder, Check reads its changes for articles to update, Read lets the bots read it without checking its changes, and Hide takes it out of what Docmunk reads.
Check right away
Select Check now. “Checked the new app changes” means Docmunk found changes to read; “No new app changes” means nothing changed since the last check. App updates lists each check and what it found. Proposed edits wait in Changes, under To review.
Choosing when to check
Start with once a day. Change it when:
- You ship several times a day and want edits soon after: choose on every push, and keep 10 min, so a run of pushes makes one check.
- You release from tags, not from your default branch: set Follow to release tags, so articles match what customers have.
- Part of your repository holds code customers never see, such as an admin tool or tests: set that folder to Read or Hide.