Enhanced Documentation Site Features
Our Solace Technical Documentation site provides additional features to help you find the answers you need more efficiently, get more out of our documentation, and improve your user experience.
We strive to improve your experience and are grateful for any feedback you can provide. If you see functionality that isn't available on a page, missing functionality, or even functionality you'd like to see, click the Feedback button and let us know. If you can provide your contact information as part of the Feedback form, we'd appreciate the opportunity to follow up with you.
Markdown Files of Content (Experimental)
Documentation pages are available in Markdown format. They are designed to make it easier to use Solace documentation content with AI-based tools and LLM-powered workflows. You may find this feature useful if you're building retrieval pipelines, feeding context into a chatbot, or working with AI assistants. In these cases, you can pull page content directly as Markdown. The Markdown version preserves the page's structure (headings, tables, and code blocks) without the surrounding site layout and noise, such as scripts. Tables are provided in HTML format to ensure the semantics of the tables are preserved.
This feature is experimental and evolves based on your feedback. To access the Markdown, you can perform one of the following actions:
- On pages where you see Download Markdown and Copy Markdown buttons, you can click them to access the Markdown.
- On pages where you don't see Download Markdown and Copy Markdown buttons, such as in our API reference content and reference guides, you can change the
.htmor.htmlfile extension in the page's URL to.mdto access the Markdown.
Let us know if you run into any issues. We appreciate your feedback.
In-Page Table of Contents (ToC)
Longer documentation pages display an in-page table of contents (ToC) on the right of the content, giving you a persistent overview of the page's structure as you read.
You may find this feature useful when working through long reference or concept topics. The in-page ToC lists every heading on the current page and updates dynamically as you scroll, highlighting your current position. You can click any heading on the in-page ToC to jump directly to that section at any time. The in-page ToC is not available in the mobile view.
Solly AI — Chat with Our Docs (Early Access)
Solly AI is an AI-powered assistant built into the Solace documentation experience. You can ask questions in plain language and receive answers drawn from Solace documentation, API release notes, and Solace Community.
You may find this feature useful if you have a specific question and want a direct answer without searching manually through pages. You can click the Ask Solly AI link at the top of every page on our Solace Technical Documentation site. For more information about using Solly AI and related AI-based tooling disclaimers, see About Solly AI and Disclaimer.
Landing Pages
Major documentation sections open on dedicated landing pages, giving you a structured overview of each area before you navigate to individual topics.
These landing pages are useful if you're exploring a new area of the documentation and want to understand what's available before you begin. We've curated the information to help you explore areas of the documentation so that you can navigate directly to the content you need rather than working through the topic tree sequentially.
Search Filter
The search experience on our Solace Technical Documentation site includes content-type filters, so you can narrow results to the content most relevant to your work.
You may find this feature useful if you work primarily with one product area and want to avoid sorting through unrelated content. When you run a search, you can filter results by event broker services (Cloud), software event brokers (Software), or appliance event broker (Appliance). You can also filter by Micro-Integration. You can apply or change a filter at any time from the search results page.