Build bounded lexical indexes of supported course text and text PDFs

Open
  • Is something wrong?
#39 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
javascript, node.js
Domain
backend, search

Research direction

Read AGENTS.md and docs/PROJECT_CONTEXT.md, then review #38 and #37 because their contracts must land first. Start with src/content.js and the HTML, PDF, and folder readers; the issue also calls for a new index/chunk model. Use the synthetic MK/EN/SQ corpus to check bounded chunks, citations, access boundaries, extraction scope, and unsupported sources; follow the listed offline and runtime checks.

Written by the indexing model from the issue text.

Description

area:backend area:docs priority:medium status:blocked type:feature

Part of #28 · Target: Retrieval / v0.4

Goal and scope

Index explicitly selected enrolled courses and supported documents with stable resource/page citations. Use Unicode-aware lexical tokens and bounded chunks; retain extraction scope, freshness and unsupported/partial sources.

Implementation starting points

new index/chunk model, src/content.js, HTML/PDF/folder readers. Follow AGENTS.md and docs/PROJECT_CONTEXT.md; reuse existing authorization, safe-error and synthetic-fixture patterns. New runtime dependencies need a documented reason.

Dependencies and readiness

Depends on #38, #37. Discuss the design before starting implementation; dependent contracts must land first.

Out of scope

No embeddings/vector service, OCR, external crawling or silently indexing every course.

Acceptance criteria and test plan

Synthetic MK/EN/SQ corpus tests cover PDF pages, HTML tables, duplicate sources, inaccessible/non-text material and input limits. Chunks cannot cross account boundaries; each hit traces to an accessible source/page and extraction version.

Run the relevant offline tests, npm run check and git diff --check; runtime changes also require npm test and npm audit. Report checks not run. No faculty credentials or private course material are required for a contribution.

Contributing

Comment here before starting so the maintainer can coordinate the approach and avoid duplicate work. Fork the repository, branch from master, and open a focused PR referencing this issue. No assignee or delivery deadline is set; required checks and review apply.

Dominant language
JavaScript
Stars
0
Forks
0
Avg merge
1h 25m
Merged PRs (30d)
13

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mahmutmft/courses-mcp

All issues in mahmutmft/courses-mcp

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.