- 
                Notifications
    
You must be signed in to change notification settings  - Fork 34
 
Hayhooks documentation website #167
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this 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.
| 
           @anakin87 Thanks! Let me do another iteration removing what's unnecessary  | 
    
| 
           Much better!  | 
    
| 
           @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.  | 
    
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well done!
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:
To publish it (script will be eventually swapped for a GA soon):
TODO:
Homeand link docs website