Guide

Add Docs to Help Center

browzer19 stepsAgent View (JSON)

Overview

Browzer's Help Center feature enables you to publish professional documentation to a public portal where users can access guides and API references. This workflow walks you through setting up your docs portal, creating organizational categories, selecting which documentation to publish, and verifying the content is live. Publishing documentation makes your product knowledge accessible to customers and reduces support burden by providing self-service resources. The help portal is hosted at a dedicated URL (e.g., help.trybrowzer.com) and can be customized with your own domain.

Before you begin

  • A Browzer account with admin or documentation management permissions
  • Access to the Browzer dashboard at trybrowzer.com
  • At least one piece of documentation (e.g., API guides or setup instructions) ready to publish
  • A web browser with JavaScript enabled

Step by step

1
ClickDocs Portal Manage your public documentation portal Browzer /browzer New Portal Transfer portal Portal Settings Enabled Live Portal URL https://help.trybrowzer.com Open Title URL Slug Description Documentation URL (optional) Scopes Exa searches to th

Navigate to the Docs Portal management page in your Browzer dashboard. This is the control center where you manage your public documentation portal settings, including the live portal URL and publishing options.

Tip. Bookmark this page for quick access when you need to update or publish new documentation in the future.
Step 1
2
ClickSelect Add Custom Domain to Docs Portal

Enable the option to add a custom domain to your Docs Portal by clicking the 'Add Custom Domain' checkbox. This allows you to use your own domain (e.g., docs.yourcompany.com) instead of the default Browzer-hosted URL.

Step 2
3
ClickSelect Create Docs Portal

Create the Docs Portal by clicking the 'Create Docs Portal' checkbox to initialize your help center infrastructure. This sets up the portal backend and prepares it to receive published documentation.

Step 3
4
ClickSelect all (3)

Select all available documentation items by clicking the 'Select all (3)' dropdown. This shows all documentation ready to be organized and published. You can deselect individual items later if you want to exclude specific guides.

Tip. If you have many documentation items, use this dropdown to quickly select or deselect in bulk rather than clicking each item individually.
Step 4
5
ClickCreate new

Click the 'Create new' button to begin creating a documentation category. Categories help organize your documentation and make it easier for users to find related content.

Step 5
6
TypeNew category name

Type a descriptive name for the new documentation category in the 'New category name' text field. Use clear, user-friendly names that reflect the content (e.g., 'API Reference', 'Getting Started', 'Integrations').

Tip. Use short, memorable category names that align with how your users think about your product features.
7
ClickAdd

Click the 'Add' button to save the new category. The category will now appear in your documentation structure and be available for assigning documentation items.

Step 7
8
ClickSelect all (3)

Select all documentation items again by clicking the 'Select all (3)' dropdown. This ensures all your guides are selected and ready for the next step in the publishing process.

Step 8
9
ClickDocs Portal

Click on the 'Docs Portal' button to view or confirm your portal configuration. This displays the current state of your docs portal, including enabled status, live URL, and selected items.

Step 9
10
ClickSelect Browzer API Key for MCP

Check the 'Browzer API Key for MCP' checkbox to include this specific documentation page in your published help center. This API documentation is a key reference for developers integrating with Browzer.

Step 10
11
ClickDeselect all (3)

Click the 'Deselect all (3)' option in the dropdown to clear all currently selected documentation items. This allows you to start fresh and select only the specific items you want to publish.

Tip. Use this step if you want to narrow down your publication to only a subset of your documentation, rather than publishing everything at once.
Step 11
12
ClickAccount Management

Click on the 'Account Management' button to access account-level documentation. This may include guides related to user accounts, permissions, and profile settings that should be published to your help center.

Step 12
13
ClickPublish 3

Click the 'Publish 3' button to publish the three selected documentation items to your live help center. This action makes the selected guides immediately available to users on the public portal.

Tip. After publishing, it may take a few seconds to a minute for the documentation to fully propagate to the live help center. Refresh the page if you don't see the updates immediately.
Warning. Publishing is generally reversible (you can unpublish later), but ensure the documentation is accurate and complete before clicking Publish, as users will have immediate access.
Step 13
14
Switch Tab

Switch to a new browser tab to prepare to view the live help center. This keeps your Browzer dashboard open while you verify the published content.

15
ClickOpen

Click the 'Open' link to navigate directly to your live Docs Portal. This link is provided in the Docs Portal settings and opens your public help center in the new tab.

Tip. You can share this link with users, customers, or team members to direct them to your documentation.
Step 15
16
Navigate

Navigate to your help center domain (e.g., help.trybrowzer.com). The page should load and display your published documentation organized into the categories you created.

17
Keyboard

Perform a hard refresh of the help center page using Cmd+Shift+R (on Mac) or Ctrl+Shift+R (on Windows) to clear the browser cache and ensure you're viewing the latest published content.

Tip. Hard refresh is especially useful after publishing new documentation, as it bypasses cached versions and loads the live content immediately.
Step 17
18
Navigate

Navigate to the help center again to confirm the page has fully loaded with all published documentation. The URL should display your custom domain or the default Browzer help center URL.

19
ClickBrowzer API Key for MCP 6 steps

Click on a specific documentation article (e.g., 'Browzer API Key for MCP 6 steps') to verify that the published content is accessible and readable. This confirms the documentation is live and navigable for end users.

Tip. Test multiple documentation links to ensure all published items are working correctly and displays expected content.
Step 19

Confirm it worked

  1. 1The Docs Portal page displays the live portal URL and shows 'Enabled' status
  2. 2A new documentation category appears in the category list after creation
  3. 3The publish action confirms that 3 documentation items have been published
  4. 4Navigating to the help center URL (e.g., help.trybrowzer.com) displays the published documentation and the specific guide (e.g., 'Browzer API Key for MCP') is clickable and readable

Common issues

Keep reading

Contributors

R
Rahul Arulkumaran