BBrowzerHelp Center

Guide

Create Docs Portal

browzer12 stepsAgent View (JSON)

Overview

A documentation portal serves as the public-facing hub for your project's knowledge base, allowing users to discover and navigate your docs through a branded, organized interface. By creating a portal on trybrowzer.com, you establish a centralized location where your documentation is discoverable, professionally presented, and aligned with your brand identity. This workflow guides you through the initial setup—defining the portal's title, creating a unique URL slug for easy sharing, writing a description that helps users understand the portal's purpose, and selecting a primary color that reflects your brand. Once saved, your portal is ready to host and display documentation content.

Before you begin

  • Active account on trybrowzer.com with portal creation permissions
  • A chosen title for your documentation portal (e.g., 'Product API Docs', 'User Guide')
  • A desired URL slug (lowercase, hyphen-separated, no spaces; e.g., 'product-api' or 'user-guide')
  • A brief description of the portal's purpose or audience
  • A primary brand color in hex format (e.g., '#FF6B35') or color name

Step by step

1
ClickDocs Portal

Navigate to the Docs Portal section by clicking the 'Docs Portal' link in the main navigation. This takes you to the portal management dashboard where you can create and configure documentation portals.

Tip. Bookmark this page for quick access if you plan to manage multiple portals.
Step 1
2
ClickPortal Title

Click on the 'Portal Title' text field to focus it. This field will hold the display name of your documentation portal as it appears to users.

Step 2
3
TypePortal Title

Type your chosen portal title into the field. Use a clear, descriptive name that conveys the purpose of your documentation (e.g., 'API Reference', 'User Manual', 'Developer Guide').

Tip. Keep the title concise (under 50 characters) for better display on the portal header and in search results.
4
ClickURL Slug

Click on the 'URL Slug' text field. This field defines the unique web path through which users will access your portal.

Step 4
5
TypeURL Slug

Type a URL slug into the field using only lowercase letters, numbers, and hyphens (no spaces or special characters). The slug becomes part of your portal's public URL (e.g., 'trybrowzer.com/my-api-docs' if you enter 'my-api-docs').

Tip. Choose a slug that is short, memorable, and descriptive. Avoid generic terms like 'docs' or 'help' unless they clearly represent your content. Slugs are permanent and difficult to change later.
Warning. Each slug must be unique on trybrowzer.com. If your slug is already taken, the system will reject it when you attempt to save.
6
ClickCreate Portal

Click the 'Create Portal' button to initialize the portal with your title and slug. This action unlocks additional configuration fields and enables the portal on the platform.

Tip. The button will remain disabled until both Title and URL Slug fields contain valid input.
Step 6
7
ClickDisabled

Click the 'Disabled' toggle switch to enable your documentation portal. This action changes the portal's status from draft/disabled to active, making it visible and accessible to your audience.

Tip. Leave the portal disabled during setup if you want to complete all configuration before publishing. You can always toggle it later.
Warning. Enabling the portal makes it publicly accessible. Ensure all content and branding is ready before flipping this switch.
Step 7
8
ClickDescription

Click on the 'Description' text field to focus it. This field holds a brief explanation of your portal's purpose, which appears to users as an introductory blurb.

Step 8
9
TypeDescription

Type a clear, engaging description that explains what users will find in your portal and who it's intended for. For example: 'Complete REST API documentation for developers integrating with our platform.'

Tip. Keep descriptions under 160 characters for optimal display on preview cards and listing pages. Use plain language that is easy to scan.
10
ClickPrimary Color

Click on the 'Primary Color' text field. This field accepts a color value that will be applied as the main brand color throughout your portal's interface.

Step 10
11
TypePrimary Color

Enter a color value in either hex format (e.g., '#FF6B35') or as a standard color name (e.g., 'blue', 'crimson'). This color will be used for buttons, headings, links, and other primary UI elements in your portal.

Tip. Use an online color picker tool to find and copy hex values. Ensure sufficient contrast between your primary color and text for accessibility. Test your color choice in a preview before final save if available.
12
ClickSave Changes

Click the 'Save Changes' button to persist all portal configuration (title, slug, description, primary color, and enabled status) to the system. Your portal is now created and ready to host documentation.

Tip. If you see a success message, your portal has been saved. If validation errors appear, review each field for typos or invalid characters and try again.
Warning. Changing the URL slug after save may break existing links to your portal. Save your slug carefully and test the URL before sharing publicly.
Step 12

Confirm it worked

  1. 1The 'Create Portal' button is no longer disabled and the form validates without errors
  2. 2After clicking 'Save Changes', a success confirmation message appears on screen
  3. 3The newly created portal is listed in your Docs Portal dashboard with the correct title and slug
  4. 4Navigating to the portal's URL (e.g., trybrowzer.com/[your-slug]) displays the portal with the configured primary color and description

Common issues

Keep reading

Building a Comprehensive Documentation Portal: A Step-by-Step Guide- BladeDocs

Building a Comprehensive Documentation Portal: A Step-by-Step Guide- BladeDocs # Building a Comprehensive Documentation Portal: A Step-by-Step Guide In today’s digital landscape, providing seamless

bladedocs.com

Create a Page | docusaurus-portal

Create a Page | docusaurus-portal On this page Add Markdown or React files to`src/pages` to create a standalone page: - `src/pages/index.js`->`localhost:3000/` - `src/pages/foo.md`->`localhost:3000

main-portal.vercel.app

Create step-by-step guides

Create step-by-step guides Skip to content Last updated 9 months ago # Create step-by-step guides Deprecated docs The developer portal beta is [approaching end of life](https://redocly.com/pro

redocly.com

Contributors

R
Rahul Arulkumaran