feat: add AI-assisted documentation guide to library search
Maintainer thường phản hồi trong vòng 1 ngày
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 30/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- javascript, json
- Lĩnh vực
- ai, backend, build-system, documentation, frontend, search, testing
Hướng nghiên cứu
Start by reviewing the build-time library search index in #114 and the MCP documentation exposure in #117, then trace how kb-docs artifacts feed the search index and MCP document discovery. Done means a versioned source manifest, validation failures for missing or malformed data, grounded guide answers with citations, compatible identifiers, and automated tests for validation and failure cases.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Feature Description
Turn Library landing-page search into an AI-assisted documentation guide. Users should ask natural-language questions and receive grounded answers with relevant documentation links and cited sources, rather than only keyword-matched results.
Documentation publishers must provide supplemental machine-consumable source metadata/content so search indexing and MCP clients can retrieve reliable source material without scraping rendered HTML.
Problem / Opportunity
Keyword search helps users find known titles, but does not guide users who describe an outcome, problem, or concept in natural language. Current rendered documentation is also unsuitable as a stable source interface for AI and MCP consumers.
A shared structured source contract lets Library UI and MCP server use same canonical documentation data.
Acceptance Criteria
- Library landing page provides AI-assisted guide mode alongside existing search experience.
- User can submit natural-language documentation questions.
- Guide returns answer grounded only in indexed documentation sources.
- Every answer shows links or citations to supporting documentation pages.
- Documentation artifacts support supplemental machine-consumable source data.
- Source contract defines stable document identifiers, content/source locations, title, route, description, tags, MIME type, and modification metadata.
- Contract format and validation are documented; JSON is preferred unless YAML provides a clear contract advantage.
- Build validates structured source data and incorporates it into generated search/MCP indexes.
- Missing, malformed, or stale source data produces actionable build validation failures.
- Search index, AI guide, and MCP server consume compatible stable identifiers and metadata.
- Automated tests cover source-contract validation, grounded guide responses/citations, and failure cases.
Proposed Solution
Define versioned structured documentation-source manifest shipped with kb-docs artifacts. Generate catalog/search data from manifest during build. Use this shared data source for landing-page AI guide and MCP document discovery/retrieval.
Keep AI answer generation behind an interface so deployment can select model/provider without coupling artifact contract to one vendor.
Dependencies / Related
Depends on #114 — build-time library search index.
Depends on #117 — expose knowledge-base documentation through an MCP server.
Additional Context
This issue delivers guided natural-language discovery above deterministic search. It should not require scraping rendered HTML. Structured source data must remain safe for machine consumption by MCP-compatible clients and future AI integrations.
- Ngôn ngữ chính
- JavaScript
- Star
- 0
- Fork
- 0
- Merge trung bình
- 20 phút
- Pull request đã merge (30 ngày)
- 8
Chuẩn bị môi trường
- Có Dockerfile hoặc tệp Docker Compose
- Không có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của AbsaOSS/knowledge-base
-
feat: expose knowledge-base documentation through an MCP serverCó thể đã có người làm @oto-macenauer-absa đã nhận 14 ngày trước. Đang mởenhancement
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
AbsaOSS/knowledge-base#117 · 1 người được giao ·
Maintainer thường phản hồi trong vòng 1 ngày
-
enhancement
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 52/100
AbsaOSS/knowledge-base#114 · 1 reaction ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
AbsaOSS/knowledge-base#113 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Dynamic responsive masthead menu from documentation manifestsCó thể đã có người làm @oto-macenauer-absa đã nhận 18 ngày trước. Đang mởenhancement
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 48/100
AbsaOSS/knowledge-base#111 · 1 người được giao ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của AbsaOSS/knowledge-base
Issue tương tự
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Billionmail/BillionMail#389 ·
-
beginner-friendly category:finding-titles community enhancement first-timers-only good first issue hacktoberfest help wanted low hanging fruit micro-contribution type: task up-for-grabs
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 85/100
Berserk-hub150/skillhawk#227 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 8 ngày
-
Remove responsibilities not working in Custom Roles & BadgesCó thể đã có người làm @thomasgwatson đã nhận hôm nay. Đang mởagent-ready agent:needs-test
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 66/100
Maintainer thường phản hồi trong vòng 2 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
gkjohnson/three-mesh-bvh#933 ·
-
scope: curriculum status: waiting triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
freeCodeCamp/freeCodeCamp#71076 ·
Maintainer thường phản hồi trong vòng 1 ngày