Skip to content

Trial AskAI markdown indexing #148

@thibaudcolas

Description

@thibaudcolas

Summary

Trial Algolia's AskAI feature with dedicated Markdown indexing to improve AI-powered search answers for Draftail documentation.

Motivation

AskAI provides AI-generated answers based on documentation content. Using a dedicated Markdown index (separate from the keyword search index) can significantly improve answer quality by:

  • Providing cleanly structured, text-only content to the LLM
  • Removing navigation and layout elements that dilute content
  • Optimizing chunk sizes for better context
  • Enabling better filtering with facets (language, version, etc.)

Implementation

Set up a separate Markdown index using Algolia's crawler with the helpers.markdown() and helpers.splitTextIntoRecords() utilities. This would complement our existing DocSearch index.

Key Steps

  1. Update crawler configuration to create a dedicated Markdown index
  2. Configure the index with appropriate settings for AI consumption
  3. Integrate the Markdown index with DocSearch's AskAI feature
  4. Test answer quality and adjust maxRecordBytes as needed

Resources

Benefits

  • Better AI-generated answers for documentation queries
  • Separation of search and AI answer concerns
  • Ability to optimize content structure specifically for LLMs
  • Potential cost optimization through better chunking

Acceptance Criteria

  • Markdown index created and configured
  • Crawler updated to populate the Markdown index
  • AskAI integrated with both keyword and Markdown indexes
  • Answer quality tested and validated
  • Documentation updated with configuration details

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestinfrastructureType: CI/CD, build, deployment, toolinglowPriority: Nice to have, when time permitsmedium effortEffort: 2-8 hours of worksearchScope: Search functionality (Algolia)

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions