Skip to content

Add searchable documentation to DevEx website #132

@Meekowen

Description

@Meekowen

Problem statement

The current DevEx documentation on https://devex.intersectmbo.org does not provide any search functionality. As the documentation grows, developers must rely on manual navigation and browsing, which increases onboarding friction and slows down information discovery. This makes it harder for new contributors and maintainers to quickly locate relevant guidance, definitions, or processes.

### Current State:

  1. Documentation is accessible via static navigation and links
  2. No global or contextual search UI is present on the site
  3. No documentation indexing or search tooling exists

Proposed solution

Introduce a searchable documentation experience by:

  1. Integrating a documentation search solution (e.g. Algolia DocSearch, Meilisearch, or equivalent)
  2. Indexing DevEx documentation content
  3. Adding a search input to the site header or sidebar
  4. Ensuring search results link directly to relevant pages or sections

Scope and impact

Scope

  • DevEx documentation hosted on https://devex.intersectmbo.org
  • Documentation discovery and navigation
  • Search UI integration (header or sidebar)
  • Documentation indexing and configuration
  • Contributor guidance for maintaining search content

Positive impact

  • Faster information discovery
  • Reduced onboarding friction
  • Lower support overhead for maintainers
  • Improved perception of DevEx maturity

Risk of not addressing

  • Docs become harder to use as content grows
  • Repeated questions in Discord and GitHub
  • Higher barrier to contribution over time

Checks

  • I searched existing issues and discussions
  • This is a feature/enhancement request (not a question or doc issue)

Sub-issues

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions