Skip to content

Conversation

Proce2
Copy link

@Proce2 Proce2 commented Sep 8, 2025

Changes

  • Added search endpoint to navigation in docs.json.

Why

The search endpoint was completely inaccessible in the documentation:

  • search.txt (should be .mdx).
  • Link in introduction pointed to /api-reference/query instead of /api-reference/search.

What's Fixed

  • Link correctly points to search (not query) endpoint,
  • Search appears in API Reference navigation menu.

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.

Copy link

@greptile-apps-staging greptile-apps-staging bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Greptile Summary

This PR fixes critical accessibility issues with the search endpoint documentation by performing three key changes: converting the documentation format, fixing navigation, and correcting broken links.

The main issue was that the search endpoint documentation existed as search.txt instead of the required .mdx format used by the documentation system. This prevented proper rendering and navigation integration. The PR creates a new api-reference/search.mdx file with correct MDX frontmatter that includes OpenAPI specification (openapi: 'POST /search') and properly structured content.

The new search documentation clearly differentiates the search endpoint from the query endpoint - search returns only code references (file paths, functions, snippets) without AI-generated explanations, while query provides both references and AI answers. This distinction is important for users who need different types of responses from the API.

Additionally, the PR fixes a broken link in api-reference/introduction.mdx that was incorrectly pointing to /api-reference/query instead of /api-reference/search, and adds the search endpoint to the navigation structure in docs.json so users can actually discover this functionality.

These changes integrate well with the existing documentation structure, following the same patterns used by other API endpoints like get-repository.mdx and query.mdx, ensuring consistency across the API reference documentation.

Important Files Changed

Changed Files
Filename Score Overview
api-reference/search.mdx 5/5 Creates new MDX documentation file for search endpoint with proper frontmatter and OpenAPI integration
api-reference/introduction.mdx 5/5 Fixes broken link that was incorrectly pointing to query endpoint instead of search endpoint
api-reference/search.txt 5/5 Removes outdated text file that had incorrect frontmatter format and couldn't be properly rendered
docs.json 5/5 Adds search endpoint to navigation menu to make it discoverable to users

Confidence score: 5/5

  • This PR is safe to merge with minimal risk as it only fixes documentation structure and navigation
  • Score reflects simple documentation fixes with no code logic changes that could introduce bugs
  • No files require special attention - all changes are straightforward documentation improvements

4 files reviewed, no comments

Edit Code Review Bot Settings | Greptile


Use this endpoint when you only need the source references and don't need an AI explanation.

Note: Before Greptile can search a repo, it must be indexed. See [Index Repository](/api-reference/index) for more information.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style: Missing newline at end of file - add empty line after the note

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant