Skip to content

docs: Add code search documentation#433

Merged
mike-solomon merged 4 commits intomainfrom
jkschneider/code-search-docs
Feb 24, 2026
Merged

docs: Add code search documentation#433
mike-solomon merged 4 commits intomainfrom
jkschneider/code-search-docs

Conversation

@jkschneider
Copy link
Copy Markdown
Member

@jkschneider jkschneider commented Feb 2, 2026

Summary

  • Add comprehensive documentation for trigram-based code search
  • Cover query syntax including content patterns, logical operators, and filters
  • Document symbol search with visibility, modifier, and type relationship filters
  • Explain structural pattern matching with Comby syntax
  • Describe rich vs plain output modes
  • Provide common query patterns with real-world examples
  • Include limitations section explaining when OpenRewrite recipes are needed instead

Copy link
Copy Markdown
Contributor

@mike-solomon mike-solomon left a comment

Choose a reason for hiding this comment

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

I went through and rewrote parts of it to be clearer/more in line with the tone of the docs. We could merge this in right now - but it may be best to wait until we come up with a name for it so we don't have to change URLs or mess with indexing.

@mike-solomon mike-solomon force-pushed the jkschneider/code-search-docs branch from ff336db to f3c8816 Compare February 18, 2026 18:30
jkschneider and others added 3 commits February 18, 2026 10:31
Add comprehensive documentation for trigram-based code search including:
- Query syntax reference with all supported filters
- Symbol search with visibility and modifier filters
- Type relationship filters (extends, implements, returns, throws)
- Structural pattern matching with Comby syntax
- Output modes (rich vs plain)
- Common query patterns and examples
- Limitations section explaining when to use OpenRewrite recipes instead
Makes a variety of sections clearer and more visually pleasing.
Improves formatting throughout.
Adds links to useful places.
Borrows heavily from our datasheet on moderne trigrep.
@mike-solomon mike-solomon force-pushed the jkschneider/code-search-docs branch from f3c8816 to 6f577a9 Compare February 18, 2026 18:32
@mike-solomon
Copy link
Copy Markdown
Contributor

mike-solomon commented Feb 18, 2026

I've rewritten the doc to refer to everything as Moderne Trigrep and also added/rewrote stuff based on the datasheet. Lastly, I fixed merge conflicts with main.

When testing it locally, trigrep didn't work at all so maybe we wait to merge this in until the commands work? I think CLI v4 is coming soon, too - which will change the commands again.

@mike-solomon
Copy link
Copy Markdown
Contributor

Tried again with the latest CLI and still have issues where trigrep does not work locally: https://moderneinc.slack.com/archives/C01S4M53THT/p1771433531796769

@mike-solomon mike-solomon merged commit 1d90eb5 into main Feb 24, 2026
@mike-solomon mike-solomon deleted the jkschneider/code-search-docs branch February 24, 2026 17:36
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.

2 participants