Skip to content

Use Branding Context for Public Documentation

page
4 min readUpdated

Branding Context keeps your Public Documentation aligned with your organization’s published identity. This page explains how to review your publishing settings and confirm that visitors see the intended branded documentation experience.

Overview

When you publish documentation for external readers, the Public version should present a consistent identity across the documentation site. Branding Context applies the branding configuration available for your documentation publishing setup to the public-facing experience, rather than requiring readers to configure anything themselves.

You typically use this process before sharing documentation with customers, partners, or other external audiences. Review it whenever you update publishing settings, prepare a new public documentation release, or notice that the public view does not reflect the identity you expect.

Branding is applied to the Public documentation view. Your internal workspace navigation, such as User Docs, User Guides, and Settings, remains available to authorized users separately from what public readers see.

📷 Screenshot pending: A public documentation page showing the organization’s applied branding.

Prerequisites

Before you begin, make sure that:

  • You can access the documentation workspace.
  • You have access to Settings and Publishing for the relevant documentation.
  • Your documentation has content ready to share publicly.
  • You know which documentation set you want to review in the Public view.
  • You have confirmed any organization-approved branding requirements with your documentation or marketing team.
  • You can use View Your Documentation → to open the published documentation view when it is available.

Step-by-Step Instructions

  1. Open User Docs from your documentation workspace.

  2. Select User Guides to open the documentation area you want to publish.

  3. Select Settings for the documentation you are preparing for external readers.

  4. Select Publishing to review the publishing configuration.

  5. Select 2. Publish Settings to review the settings that control the published documentation experience.

📷 Screenshot pending: The Publish Settings screen with the branding controls and public publishing options.

  1. Review the branding options available on the Publish Settings screen.

  2. Select the approved branding values for your public documentation.

  3. Review the Public publishing option to confirm that the documentation is intended for external access.

  4. Return to the documentation area after reviewing the publishing configuration.

  5. Select View Your Documentation → to open the documentation as readers will see it.

  6. Review the public documentation header and visible identity elements.

  7. Confirm that the public documentation uses the branding you selected in the publishing configuration.

  8. Return to Publishing if the public view does not match your expected branding.

  9. Update the available branding selection in 2. Publish Settings.

  10. Open View Your Documentation → again to verify the updated public presentation.

Branding Context applies the configured branding consistently to the Public documentation experience. You do not need to add branding separately to every guide or page when the publishing configuration is set correctly.

Tips and Best Practices

  • Review the Public documentation view after every branding-related change. The public view is the most reliable way to confirm what external readers will experience.

  • Use one approved branding configuration for related documentation. Consistent branding helps readers recognize that multiple guides belong to the same organization and documentation set.

  • Check your publishing configuration before announcing a new documentation link. A guide can be complete while its public presentation still needs review.

  • Keep internal and public workflows separate. Use Settings and Publishing to manage the published experience, then use View Your Documentation → to validate the reader-facing result.

  • Review public branding after making broader documentation changes, such as importing existing content through Or import existing documentation or generating new content with Generate Documentation →.

  • Do not rely only on the editing workspace when validating public appearance. Internal screens may include workspace navigation and controls that public readers do not see.

  • If your organization has multiple documentation collections, review each collection’s Publishing settings independently. Public branding should be verified for the specific documentation visitors will open.

Troubleshooting

The public documentation does not show the expected branding

  1. Open Settings.

  2. Select Publishing.

  3. Select 2. Publish Settings.

  4. Review the available branding configuration.

  5. Select View Your Documentation → after updating the configuration.

If the public view still does not match, confirm that you are reviewing the correct documentation set and its associated publishing settings.

I cannot find branding options

  1. Open Settings.

  2. Select Publishing.

  3. Select 2. Publish Settings.

If branding controls are not available, you may not have access to the required publishing settings. Ask the documentation owner or workspace administrator to review your permissions and the publishing configuration.

The documentation is not available to external readers

  1. Open Settings.

  2. Select Publishing.

  3. Review the Public publishing option.

  4. Confirm that the documentation is configured for the intended audience.

Then select View Your Documentation → to verify the reader-facing result.

Was this page helpful?

Download as PDF
Use Branding Context for Public Documentation — Atloria (self dogfood)