Generate TypeDoc API reference for src/query module
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 82/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- typescript
- Domain
- documentation
Research direction
Start with website/docusaurus.config.ts and website/sidebars.ts, comparing the existing Schema, Indexes, and Vectorizers API Reference entries. Run npm --prefix website run build after adding the query entry point and sidebar category. Done means the build succeeds and produces a docs/api/query/ tree containing the query API reference.
Written by the indexing model from the issue text.
Description
website/docusaurus.config.ts currently feeds typedoc only src/schema/index.ts, src/indexes/search-index.ts, and src/vectorizers/index.ts. None of the query classes — VectorQuery, HybridQuery, FilterQuery, CountQuery, VectorRangeQuery, TextQuery, FilterExpression, etc. — have generated API reference pages.
Acceptance criteria
- Add
../src/query/index.tsto theentryPointsarray indocusaurus.config.ts. - Add a "Query" category to
website/sidebars.tsunderAPI Reference, mirroring the existing Schema/Indexes/Vectorizers structure. - Verify
npm --prefix website run buildproduces adocs/api/query/tree.
- Dominant language
- TypeScript
- Stars
- 1
- Forks
- 3
- Avg merge
- 34m
- Merged PRs (30d)
- 3
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from redis-developer/redis-vl-typescript
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
All issues in redis-developer/redis-vl-typescript
Similar issues
-
clawsweeper:fix-shape-clear clawsweeper:queueable-fix clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster no-stale P3
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 76/100
-
code-quality refactoring
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
github/gh-aw-firewall#8816 ·
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
vercel/react-tweet#225 ·