Sharing

Documentation sharing allows you to generate public links to your documentation content through connected widgets. These links provide external access to your documentation pages while maintaining consistent branding and navigation.

Widget Selection

When sharing documentation content, you can select from multiple widgets because a single documentation can be attached to multiple widgets. This relationship allows the same documentation content to be accessible through different widget interfaces.

For more details on widget connections, see the Widget Connections documentation.

Each widget represents a different public interface where your documentation content can be viewed. When a documentation is assigned to multiple widgets, the share modal becomes available for all connected widgets, allowing you to choose which widget's URL structure to use for sharing.

Public Documentation Pages

The generated links redirect to public documentation pages that share the same design as their corresponding widget. This means the visual appearance and branding of the shared documentation content will match the widget it was shared through.

Learn more about public documentation pages in the Public Documentation documentation.
Only published categories and pages can be shared publicly. Unpublished content is not accessible via share links.

When sharing individual documentation pages, the modal provides two different link types with distinct advantages:

  • URL Structure: Uses category/page names in the path
  • Example: /d/getting-started/installation
  • Advantages: Human-readable, SEO-friendly
  • Disadvantages: Breaks if names change (category or page name modifications)
  • Best for: Google indexing, chat links, temporary sharing
  • URL Structure: Uses page ID for permanent referencing
  • Example: /d/redirect?id=abc123
  • Advantages: Never breaks from reorganization or name changes
  • Disadvantages: Less readable, not SEO-optimized
  • Best for: Documentation, permanent references, API integrations
Direct links will break if any part of the content structure changes (category name or page title). Use fixed links when you need permanent, reliable links.
Choose direct links for user-facing content where readability matters, and fixed links for internal documentation or systems that need guaranteed long-term access. As an example, links in this documentation use the Fixed Link format.