Configure portal branding to make your published documentation recognizable as part of your organization. Branding helps readers identify the correct documentation portal when they open shared or public documentation.
Overview
Published documentation is accessed through the publishing area of the Documentation Hub. After your documentation is generated and reaches the Published stage, you can open the published portal and review how it appears to readers.
Use portal branding when you need your organization’s documentation portal to present a consistent identity across published content. Before sharing a portal link, review the published view to confirm that the branding and documentation presentation are appropriate for your audience.
Your documentation moves through the publishing workflow from setup and configuration to publication. The visible publishing-related indicators include 2. Configured, 3. Published Status, and Published. Branding changes should be reviewed in the published portal after the documentation is published.
📷 Screenshot pending: The Documentation Hub showing the Published Docs navigation area and View Published Docs action.
Prerequisites
Before you begin, make sure that:
- You can access the Documentation Hub.
- Your documentation has been generated or imported.
- The documentation is configured and ready for publishing.
- Your documentation shows a Published status, or you are ready to publish it after completing configuration.
- You have the organization branding information you want to use, such as approved organization naming and visual assets.
- You have permission to configure publishing settings for the documentation portal.
Step-by-Step Instructions
-
Open the Documentation Hub.
-
Locate the publishing area that shows 4. Published Docs Nav.
-
Click Configure → to open the available configuration options for your documentation.
-
Open the portal branding controls in the publishing configuration area.
-
Enter or select your organization’s approved branding information in the available branding controls.
-
Save or apply the branding changes using the save action displayed in the configuration area.
-
Confirm that the documentation is configured by reviewing the 2. Configured indicator.
-
Publish the documentation if it is not already published.
-
Review the 3. Published Status area to confirm that the portal is marked Published.
-
Click 🌐 View Published Docs to open the reader-facing documentation portal.
-
Review the published portal to confirm that the organization branding is displayed as expected.
-
Return to the configuration area and update the branding controls if the published appearance needs adjustment.
📷 Screenshot pending: The publishing configuration area with the portal branding controls and the action used to save branding changes.
Tips and Best Practices
-
Apply only approved organization branding. Use the same organization name, logo, and visual conventions that readers expect from other customer-facing materials.
-
Review branding in the published portal, not only in the configuration area. The 🌐 View Published Docs action gives you the reader-facing view that external users will see.
-
Complete branding review before broadly sharing the portal. A portal may be technically available once it is Published, but you should verify its presentation before distributing its link.
-
Keep branding consistent across documentation updates. When you generate new documentation with Generate Documentation →, or use Or import existing documentation, revisit the published portal to make sure the presentation remains appropriate.
-
Use View Your Documentation → when you need to review the documentation content itself. Use 🌐 View Published Docs when you need to check the published reader experience.
-
Treat configuration and publication as separate checks. 2. Configured indicates that setup is complete, while Published and 3. Published Status indicate the availability of the published portal.
Related Pages
- Generate Documentation
- Import Existing Documentation
- Publish Documentation
- View Published Documentation
- Configure CI/CD
- Export Documentation
Troubleshooting
The published portal does not show the expected branding
Open 🌐 View Published Docs again after saving your changes. If the previous appearance remains visible, return to Configure →, verify the branding information, save the changes, and then refresh the published portal.
I cannot find the branding controls
Start from the Documentation Hub and select Configure →. Branding is part of the publishing configuration experience, not the generated documentation content view. If you only see content-generation options such as Generate Documentation →, complete or open the documentation configuration first.
The portal is not available to review
Check 3. Published Status. If the documentation is not marked Published, complete the publishing process before selecting 🌐 View Published Docs.
Was this page helpful?