Set up your first product
Setup gets a product from nothing to a live help center that Docmunk checks against your code. You add the product, then work through three steps on Setup. The second step can wait.
Before you start
- You’re an owner or admin.
- You know your app’s address, where people sign in.
- You know where your help center is now: a public help site, a docs folder next to your code, or nowhere yet.
- To link your code, you need a GitHub account that can install apps where the repository lives.
- About 10 minutes of your time. Docmunk does the rest in the background.
1. Add the product
Select the product name at the top of the rail, then select Add a product…. With no product yet, select Add a product on the Products page. Enter the Name and the App address, and select Add. Setup opens.
2. Bring in your help center
Under Where are your articles now?, choose where they are:
- On a live help site: any public help site. Docmunk reads each article and its pictures from the address you enter.
- In our code repository: a Mintlify docs folder next to your code. Link your code first.
- Nowhere yet: Docmunk drafts a help center from your code, or you start empty.
Each one is in Bring in your help center.
3. Link your code
Under Link your code, select Install the GitHub App and install it on GitHub. Back on Setup, pick the Repository and select Link and clone. Docmunk copies the repository, then checks it once a day for changes that make an article wrong. See Link your code.
Not ready? Select Skip for now. Docmunk can’t find stale articles until the code is linked.
4. Publish your help center
Under Publish your help center, select Review and publish. An imported help center is already live as it came in, at the address Setup shows; only your edits wait for a publish. A draft goes out once you mark it ready and publish it. See Publish articles.
After setup
Setup lists what to do Later, when you want:
- Check your help center: compare an imported help center with your code.
- Invite your team: add the people who review and publish.
- Add a sign-in for the bots: so they can take new pictures in your app.
- Brand your help site: your logo, color, and font.
Next: Review proposed edits