Get started with Docmunk
Choose an article source on Set up, link your code if you want Docmunk to read it, then publish from Articles.
Before you start
- Sign in to Docmunk.
- Add a product.
- Have the address of a public help site, or a linked code repository, if you’re bringing in existing articles. You can also start without existing articles.
1. Choose where your articles are
On Set up, choose where Docmunk should get your articles. Docmunk keeps a copy of each article and picture so you can work on them in Docmunk.
- In our code repository imports articles from a docs folder next to your code. The repository must be linked first.
- On a live help site imports articles from a public help site. Enter the address of a page on that site.
- Nowhere yet lets you draft a help center from your code or start with an empty help center.
In Set up, choose In our code repository
Docmunk looks for docs folders in the linked repository. Choose a folder, then select Import 2 pages. If the repository isn't linked, select Link and clone after choosing a repository.
In Set up, choose On a live help site
Enter the address in the help-site address field, then select Import. Docmunk reads the help site and works out what its pictures show.
In Set up, choose Nowhere yet
Choose one of these options:
- Draft it from your code reads the linked code and opens the draft flow.
- Or write the first article opens a blank article dialog.
2. Link the product code
On Set up, Docmunk watches the linked repository and reads each change. It suggests edits to articles that no longer match.
Only an owner or admin can connect GitHub.
Choose one of these code sources:
- A sample's code, without GitHub links the available sample code without GitHub. Choose a sample from Sample, then select Link.
- The App on GitHub installs the GitHub App when no GitHub installation is connected.
- Repository lists the repositories available through GitHub. Choose a repository, then select Link and clone.
If you skip this step, select Skip for now. You can link the code later from Code.
3. Review the imported articles
On Articles, Docmunk lists the articles it copied and groups them into collections. Select Open the articles to read them.
If you don't have articles yet, select New article to write one or select Help site to bring in an existing help site.
4. Publish the help center
On Articles, select Publish. Review the articles and select Publish when they're ready. Docmunk puts the help site live at the product's help-site address.