Skip to content

Conversation

mpangrazzi
Copy link
Contributor

@mpangrazzi mpangrazzi commented Sep 30, 2025

Should close #93.

With this we're splitting the big README of Hayhooks in a docs website powered by Material for MkDocs.

Currently, the website is live on GH Pages here: https://deepset-ai.github.io/hayhooks/

To run a development docs website server, you need to do:

hatch run docs:serve

To publish it (script will be eventually swapped for a GA soon):

hatch run docs:deploy

TODO:

  • Swap current README with docs website's Home and link docs website
  • Update Open WebUI docs (they should reflect last versions changes)

Copy link
Member

@anakin87 anakin87 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some initial comments.

My suggestion would be to make the docs essentially the current README, just better organized into sections. That way we keep the content minimal but clear and useful.

@mpangrazzi
Copy link
Contributor Author

@anakin87 Thanks! Let me do another iteration removing what's unnecessary

Comment on lines 226 to 229
prompt_builder = PromptBuilder(
template="Based on this content: {{documents}}\nAnswer: {{query}}"
)
llm = OpenAIChatGenerator(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that the PromptBuilder can be connected with a Chat Generator. Let's search for similar examples and fix them.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch, they should be fixed now!

@anakin87
Copy link
Member

anakin87 commented Oct 3, 2025

Much better!

@mpangrazzi
Copy link
Contributor Author

@anakin87 I fixed most of the things, will do another review next Monday, then if ok swap the README with the "Home" page content and link the docs website. I'll also open issues for adding a GA to auto-update the docs website.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Review Hayhooks README.md
2 participants