cheshire-cat-ai / docs

Documentation for the Cheshire Cat AI
https://cheshire-cat-ai.github.io/docs/
31 stars 27 forks source link

Update hooks documentation #156

Closed lucagobbi closed 1 month ago

lucagobbi commented 1 month ago

Hooks documentation is a bit outdated compared to the latest core updates. I've prepared some updates to keep it aligned, though there might still be some gaps.

The missing hooks before_cat_stores_episodic_memory, after_rabbithole_stored_documents, rabbithole_instantiates_parsers, rabbithole_instantiates_splitter are now documented.

This should also address issues #151 and #155

Additionally, we need to update the docstrings in the core, as there are some discrepancies in the python reference docs. Plus, having consistent type hinting in the hooks' definitions and examples can help developers avoid errors and implement hooks correctly.

lucagobbi commented 1 month ago

This looks fine to me, thank you Luca

The only point is the update of the tool prompt, I was said it might change soon, so we could wait a little before merging this one if it is not urgent

I agree. The agent instructions prompt is already outdated compared to the develop branch. My proposal is to skip that part for now and merge the other changes. It feels like development is progressing too quickly for the documentation to keep up

kodaline commented 1 month ago

This looks fine to me, thank you Luca The only point is the update of the tool prompt, I was said it might change soon, so we could wait a little before merging this one if it is not urgent

I agree. The agent instructions prompt is already outdated compared to the develop branch. My proposal is to skip that part for now and merge the other changes. It feels like development is progressing too quickly for the documentation to keep up

it's fine for me, to skip it for now and merge the rest that is useful to be on the docs asap :)

pieroit commented 1 month ago

This looks fine to me, thank you Luca The only point is the update of the tool prompt, I was said it might change soon, so we could wait a little before merging this one if it is not urgent

I agree. The agent instructions prompt is already outdated compared to the develop branch. My proposal is to skip that part for now and merge the other changes. It feels like development is progressing too quickly for the documentation to keep up

Agree, we should give priority to docs as it is not that useful adding features nobody knows are there :')

kodaline commented 1 month ago

My proposal is to skip that part for now and merge the other changes. It feels like development is progressing too quickly for the documentation to keep up

Whenever you want, remove the update of the tool prompt and we are ready to merge this one I guess

lucagobbi commented 1 month ago

My proposal is to skip that part for now and merge the other changes. It feels like development is progressing too quickly for the documentation to keep up

Whenever you want, remove the update of the tool prompt and we are ready to merge this one I guess

Yess, Im out of home now. Will do it in the evening! Thank you @kodaline !!

kodaline commented 1 month ago

@pieroit we can merge this one I think, thanks for the update @lucagobbi