embed_docsite: use git clone to download source files from repo
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 5
- Forks
- 10
- Avg merge
- 2d 20h
- Merged PRs (30d)
- 17
Description
In embed_docsite, we download the docs source from github repos before processing and uploading to pinecone.
In github_utils right now, we download these files one at a time by downloading the index and then fetching each file.
I'd be willing to bet a shiny pound that git clone --depth 1 will be easier, faster, and more robust.
I've love to swap out the implementation here on a slow day. And run a quick test on the time-to-download before and after the change
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.
Research direction
Start in github_utils within embed_docsite and trace the current GitHub source-download path before processing and uploading to pinecone. Compare the current download time with a shallow git clone, then verify that the downloaded source still supports the existing processing and upload flow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, github, jupyter-notebook
- Domain
- backend
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100