posit-dev / posit-dev/positron
Assistant: Add tools for Assistant to read Python documentation
Open
Nobody has claimed this yet.
area: assistant
lang: python
- Dominant language
- TypeScript
- Stars
- 4.3k
- Forks
- 184
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 195
Description
As of https://github.com/posit-dev/positron/pull/8421, Positron Assistant can refer to R help pages and vignettes, but it doesn't have similar tools to read Python documentation.
We should add these tools so that Assistant can read locally installed Python help, with the goal of being:
- more specific (the documentation has details/nuances that aren't already known by the model)
- more local (locally installed packages/documentation may not be part of the model's training data, especially if they are internal tools)
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
Review PR #8421 and the existing Assistant support for R help pages and vignettes first. Then identify how locally installed Python documentation can be exposed to Assistant; done means it can read that documentation with more specific, local context.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, typescript
- Domain
- ai, developer-experience, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100