Enhanced Documentation Site Features

The Solace Technical Documentation site provides additional features to help you find information more efficiently and get more out of the documentation.

We appreciate 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 (Beta)

Documentation pages are available in Markdown format. You can use them to bring Solace documentation content into AI-based tools and large language model (LLM)-based workflows. You may find this feature useful if you're building retrieval pipelines, feeding context into a chatbot, or working with AI applications. 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, navigation, and scripts. Tables appear in HTML format to preserve their semantics.

To access the Markdown, perform one of these 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 .htm or .html file extension in the page's URL to .md to access the Markdown version of the file.

This feature is in Beta and evolves based on your feedback. If you use these files and have suggestions, click the Feedback button and let us know.

AI Agent Index Files — llms.txt (Beta)

We publish llms.txt, a set of per-area index files, and llms-full.txt on this documentation site. Each file contains curated links to Markdown versions of documentation pages and, in a few cases, to HTML pages. You can give these files to LLMs, AI agents, and coding assistants as context so they produce more accurate answers.

We recommend that you start with the llms.txt file, which is structured into two levels:

  • llms.txt — The top-level file (https://docs.solace.com/llms.txt) lists each product area with a short description and a link to that area’s index file. An Optional section at the end lists secondary content that an agent can skip when context is limited.

  • Per-area index files (https://docs.solace.com/llms/<area-name>.txt) — Each file lists the pages for one product, area, or feature. Each entry includes a short description and a link to the Markdown version of the page.

If your AI application fetches only one URL or performs bulk ingestion into a retrieval pipeline, use llms-full.txt (https://docs.solace.com/llms-full.txt). It concatenates all per-area files into a single document.

These files with curated links give AI agents and applications the following advantages:

  • Focused discovery — An agent reads the index, selects the relevant area from its description, and loads only those pages instead of crawling the site.
  • Token efficiency — Markdown pages omit the navigation, scripts, and styling of HTML pages, which leaves more of the context window for the task. Some Markdown files use HTML tables for tabular data.
  • Reduced hallucinations — An agent that reads the current pages has a source for product behavior, so it relies less on its training data.

Not every documentation page is listed. If you want the Markdown version of a page that isn't listed, see Markdown Files of Content.

This feature is in Beta and evolves based on your feedback. If you use these files and have suggestions, click the Feedback button and let us know.

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 (Beta)

Solly AI is an AI-powered, web-based application 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 Using 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 have 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 brokers (Appliance). You can also filter by Micro-Integrations. You can apply or change a filter at any time from the search results page.