Publish knowledge base

Overview

Use the Knowledgebase onboarding wizard (Beta) to turn your docs repository into a public knowledge base on a hosted subdomain, such as "acme.moxiedocs.app." The wizard walks you through naming the site, choosing the source repo and folders, reserving a subdomain, setting visibility defaults, and adding basic branding. When you finish, Moxie Docs writes a knowledge base configuration and publishes a hosted site on a dedicated apex.

When to use it

• You want a public home for support and product docs backed by your GitHub repo.
• You need a quick way to reserve a hosted subdomain and apply consistent branding.
• You want default visibility rules for what content appears publicly.
• You prefer a guided setup that produces a working site immediately.

How to use it

1. Open the wizard. From the Docs dashboard, start the Knowledgebase onboarding wizard (Beta).
2. Enter a knowledge base name. Provide a clear, reader-facing name for your site. This appears on the hosted site and in the dashboard.
3. Select the source repository. Choose the GitHub repo that Moxie Docs already connects to for your documentation.
4. Choose the folder structure. Pick the folders in your repo that contain the docs you want to publish. Confirm the structure matches how you want content organized on the site.
5. Reserve a subdomain. Enter the subdomain you want (for example, your company or project name). The wizard shows a live preview like "acme.moxiedocs.app" so you can confirm availability and spelling.
6. Set visibility defaults. Choose the default behavior for new and existing docs (for example, whether selected folders or categories are public by default). You can adjust item-level visibility later in the dashboard.
7. Add branding. Provide branding basics such as site name and accent choices so readers recognize your organization. The preview updates to reflect your selections.
8. Review and confirm. Check the summary of your name, source repo, folder structure, subdomain, visibility defaults, and branding. Make any needed edits before continuing.
9. Publish. Complete the wizard to write the knowledge base configuration and publish your hosted site on the reserved subdomain. You’ll see a confirmation with a link to visit your public knowledge base.
10. Verify and share. Open the subdomain link, spot-check a few pages for structure and visibility, then share the URL with your team and customers.

Options and settings

• Knowledge base name: Controls the reader-facing title shown on your hosted site.
• Source repository: Sets which GitHub repo supplies content for the site.
• Folder structure: Determines which folders are included and how content is organized.
• Subdomain reservation: Reserves and assigns a hosted address like "yourname.moxiedocs.app."
• Visibility defaults: Establishes what content is public by default; you can refine item-level visibility later.
• Branding: Basic visual details so your public site reflects your organization.

Tips

• Check your folder selections carefully; the site navigation mirrors your chosen structure.
• If a page doesn’t appear publicly, review the visibility defaults and the item’s visibility in the dashboard.
• Keep the name and branding consistent with your other customer-facing sites to help readers trust the content.