redis / redis/redis-vl-python

Add LangCache class to sphinx documentation and user guide

Open
#425 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
Python
Stars
427
Forks
101
Avg merge
6d 3h
Merged PRs (30d)
20

Description

Need the docs update with a reference in the API section to the new langcache class. Additionally, need either a new user guide (simple) or an addition to the existing user guide for llm caching. We can store langcache uri's in with github secrets.

Contributor guide

Open the contributing guide

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.

Research direction

Start by locating the Sphinx documentation, the API section, and the existing user guide for LLM caching. Add a LangCache class reference in the API documentation and either create a simple user guide or extend the existing one, including how LangCache URIs can be stored with GitHub Secrets. Done means both the API reference and caching guidance are published.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.