Publish knowledge base

Overview

The public knowledge base lets you turn approved documentation into a reader‑friendly site for customers and partners. Moxie Docs drafts articles from your connected GitHub repo, routes them to you for review, and publishes only what you approve. You can connect a subdomain and share a live site at your-tenant.moxiedocs.app or a custom domain. Use this when you want consistent, up‑to‑date docs without manual copying.

When to use it

• You want a public site built from your repo docs without rebuilding your docs stack.
• You need human approval before anything goes live.
• You plan to share stable URLs with customers on your own subdomain.
• You want published pages kept current via docs‑only pull requests.

How to use it

1. Open Dashboard → Knowledge base setup.
2. Review the connection to your GitHub repository shown on the setup screen. If it’s already connected in Moxie Docs, you’re set for draft generation.
3. Choose a target repository and branch for commits when prompted in setup. This is where approved pages will be committed via pull request.
4. Start draft generation by selecting “Generate drafts.” Moxie Docs creates KB‑specific drafts from your repo content and queues them for review.
5. Open Dashboard → Review inbox to see new drafts. Each item shows a title, summary, and status.
6. Preview a draft by clicking its title. Check formatting, links, and accuracy.
7. Approve or request changes:
   • Click Approve to move the draft to publishing.
   • Click Request changes to send it back for updates. Add clear comments so the next draft addresses your feedback.
8. Create the pull request when prompted after approval. Moxie Docs prepares a docs‑only PR to your selected repo and branch.
9. Merge the PR in GitHub. Only merged, approved content is eligible to publish.
10. Connect a subdomain in Knowledge base setup:
    • Choose “Use tenant subdomain” to serve at your-tenant.moxiedocs.app, or
    • Choose “Use custom domain” and follow the on‑screen steps to verify and connect your domain.
11. Publish pages from the Review inbox or Publishing view:
    • Select the approved pages ready to go live.
    • Click Publish. Moxie serves them on your chosen domain.
12. Verify the live site by opening the link shown after publishing. Check navigation and search.
13. Keep content current by returning to the Review inbox regularly. New or updated drafts will appear for approval and follow the same PR and publish steps.

Options and settings

• Target repository and branch: Where approved changes are committed via PR.
• Tenant subdomain: Quick default at your-tenant.moxiedocs.app.
• Custom domain: Connect your own domain for the public site.
• Review inbox filters: Filter drafts by status (New, Changes requested, Approved, Published).
• Publish selection: Publish one page or multiple selected pages at once.

Tips

• Only approved pages that have merged PRs can be published; if a page won’t publish, check the PR status in GitHub.
• Use “Request changes” with specific comments to get better next drafts.
• After switching domains (tenant to custom), revisit your links and update any bookmarks you’ve shared.
• Rebuilds are automatic when you approve updated drafts; publish again to refresh the live page.