Configure Documentation Branding Context

You can configure the branding context used for published documentation so that readers see documentation associated with the correct organization identity. This helps keep externally shared documentation consistent with your organization’s publishing standards.

Overview

Documentation branding context controls the organization-level branding applied when documentation is published. Use it before you share documentation with customers, partners, or other external readers through the published documentation experience.

Branding configuration is part of the publishing workflow. In the Documentation Hub, you may see progress indicators such as 2. Configured and 3. Published Status. These indicators help you confirm that documentation is configured for publishing and identify its current publishing state.

After documentation is published, readers can access it through 🌐 View Published Docs or View Published Docs. You can also use View Your Documentation → to review the documentation experience from your organization’s perspective.

📷 Screenshot pending: Documentation Hub showing the Configured and Published Status areas.

Prerequisites

Before you start, make sure that:

You have access to your organization’s Documentation Hub.
Your documentation has been generated, imported, or otherwise prepared for publishing.
You have the required administrative permission to configure publishing settings for your organization.
You know which organization branding should appear in published documentation.
You are ready to publish or review the documentation after configuration.

Step-by-Step Instructions

Open the Documentation Hub for the documentation you want to brand.
Select Publishing to open the publishing workflow.
Select Configure → to review the available publishing configuration.
Open the documentation branding context for the organization.
Review the branding information displayed for the organization before publishing.
Confirm that the branding context belongs to the organization whose documentation you are preparing.
Save or confirm the branding configuration using the available action on the screen.
Review the 2. Configured indicator to confirm that the documentation configuration is complete.
Open 3. Published Status to review whether the documentation is currently published.
Select View Published Docs after publication to verify the reader-facing documentation.

📷 Screenshot pending: Organization documentation branding context settings before publication.

Review the published documentation for consistent organization branding.
Return to Publishing if you need to update the configuration before sharing the published documentation.

Tips and Best Practices

Configure branding before distributing published documentation links. Readers who use 🌐 View Published Docs should see documentation associated with the intended organization from their first visit.
Use the configuration and publishing indicators separately. 2. Configured indicates that publishing configuration has been completed, while 3. Published Status helps you determine the current publication state.
Verify the final reader experience after every branding change. Select View Published Docs rather than relying only on the configuration screen.
Keep branding changes coordinated with documentation updates. If you are also generating content, use Generate Documentation → first, then complete publishing configuration before publishing the new version.
If you are working with existing content, you can use Or import existing documentation before configuring publishing and branding.
Consider the documentation style before publishing. The Documentation Templates and The 4 Documentation Styles — path to 8+/10 each resources can help you keep the presentation and content structure consistent with your organization’s published experience.

Generate Documentation
Import Existing Documentation
Configure CI/CD
Publish Documentation
View Published Documentation
Export Documentation

Troubleshooting

The documentation does not appear ready to publish

Open Publishing and check 2. Configured. If configuration is incomplete, select Configure → and finish the available publishing configuration before checking the publication status again.

I cannot confirm what external readers will see

Select View Published Docs or 🌐 View Published Docs. This opens the published documentation experience so you can verify the organization branding and documentation presentation as a reader would see them.

My documentation is not yet available in the publishing workflow

Return to the Documentation Hub and prepare the content first. Select Generate Documentation → to generate documentation from your code, or select Or import existing documentation to work from existing documentation.