Skip to main content
In this lesson/article, we’ll explore two core Backstage capabilities that help teams build, document, and discover software: TechDocs (the built-in documentation system) and Backstage Search (the unified discovery experience). You’ll learn how each feature works, how they connect to the Backstage software catalog, and the basic authoring and indexing steps to make documentation discoverable across your developer portal.
A presentation slide titled "Docs and Search" with the subtitle "Section Introduction" on a blue-to-teal gradient background. A small "© Copyright KodeKloud" is visible in the bottom-left.
This section covers:
  • An overview of TechDocs: how Backstage renders and hosts documentation alongside software components.
  • An overview of Search: how Backstage indexes catalog entities and TechDocs content to deliver unified discovery.
  • A high-level workflow: authoring docs, connecting them to catalog entities, and ensuring they are indexed by Search.
Tip: Treat TechDocs and the Software Catalog as a combined workflow—author documentation in your repo, point a catalog entity to that repo, and Backstage will render and index the docs so your team can discover them via Search.
Why this matters
  • Faster onboarding: Centralized docs and search reduce time-to-context for new contributors.
  • Single source of truth: Docs stored with code and surfaced in Backstage stay up-to-date.
  • Discoverability: Indexing both entities and TechDocs content makes it easy to find components, APIs, and guides in one place.
Key features at a glance: What you’ll see in this section
  1. Setup and configuration steps to enable TechDocs and Search in a Backstage instance.
  2. Examples showing how to author documentation (Markdown), link it from a catalog-info.yaml, and trigger TechDocs builds.
  3. How Backstage Search indexes the rendered documentation and catalog entities so content is returned in search results.
Links and references This article will include setup instructions, configuration examples, and practical guidance to help you author TechDocs content so it becomes discoverable through Backstage Search.

Watch Video