Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Semantic Search Navigation for Long Documentation Pages #172

Open
crazygo opened this issue Jan 23, 2025 · 0 comments
Open

feat: Semantic Search Navigation for Long Documentation Pages #172

crazygo opened this issue Jan 23, 2025 · 0 comments
Labels
type: feature request New feature or request
Milestone

Comments

@crazygo
Copy link
Contributor

crazygo commented Jan 23, 2025

Let me draft the GitHub issue:

Title: feat: Semantic Search Navigation for Long Documentation Pages

Is your feature request related to a problem? Please describe.

When browsing long documentation pages (e.g., https://openresty.org/cn/components.html), it's challenging to locate specific content without knowing exact keywords. Traditional Ctrl+F search fails when users don't know the precise terms, making content discovery inefficient and time-consuming.

Describe the solution you'd like

Implement a semantic search navigation that:

  • Allows natural language queries (e.g., "find scripting related components")
  • Shows a floating search box with real-time results
  • Highlights relevant sections while dimming others
  • Provides quick-jump links to matching content areas
  • Uses embeddings/NLP to understand content context

Describe alternatives you've considered

  • Browser's built-in find (Ctrl+F) - Too rigid, requires exact matches
  • Table of contents - Not granular enough for specific content
  • Full-text search engine - Overkill for single-page navigation

Additional context

  • Target use case: Technical documentation and long-form content
  • Should work client-side to maintain page performance
  • Could leverage existing NLP libraries like TensorFlow.js for lightweight semantic matching

Would you like me to adjust any part of this issue?

@crazygo crazygo added this to the Backlog milestone Jan 23, 2025
@crazygo crazygo added the type: feature request New feature or request label Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature request New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant