Adaptor docs: Make changelogs available by tool search
Open
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 5
- Forks
- 10
- Avg merge
- 2d 20h
- Merged PRs (30d)
- 17
Description
To address user scenarios like "Why did this workflow break when I upgraded this adaptor to the latest version?", we should make the changelogs reachable by tool use by the assistant. They are too long and specialised to dump into the prompt pre-emptively. This should be built after we've decided on our overall new approach for adaptor docs.
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
First resolve the overall new approach for adaptor docs, as the issue says this work depends on that decision. Then identify where adaptor changelogs are exposed and how tool search reaches them. Done means the assistant can retrieve changelogs when needed without putting their full contents in the prompt.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, search
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100