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

@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.

@mpangrazzi mpangrazzi requested a review from anakin87 October 6, 2025 15:26
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.

Well done!

@mpangrazzi mpangrazzi merged commit 2070f51 into main Oct 7, 2025
5 checks passed
@mpangrazzi mpangrazzi deleted the mkdocs branch October 7, 2025 14:13
@mpangrazzi mpangrazzi self-assigned this Oct 7, 2025
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

3 participants