register_embedding_models() missing from plugin-hooks docs page
Open
Beginner friendly
Nobody has claimed this yet.
bug
documentation
- Dominant language
- Python
- Stars
- 12.5k
- Forks
- 998
- Avg merge
- 3d 13h
- Merged PRs (30d)
- 10
Description
https://llm.datasette.io/en/stable/plugins/plugin-hooks.html
But there are three hooks:
https://github.com/simonw/llm/blob/d34eac57d39c20d829a0c090cdda9e64705d9291/llm/hookspecs.py#L8-L20
register_embedding_models() is documented here but it should be in the list of hooks too. https://llm.datasette.io/en/stable/embeddings/writing-plugins.html
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 with docs/plugins/plugin-hooks.md and compare its hook list with the three hooks shown in llm/hookspecs.py. Check embeddings/writing-plugins.md for the existing register_embedding_models() documentation, then update the plugin-hooks page so the list includes all three hooks and verify the rendered page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 85/100