Improve README with Quick Start guide and Graphviz installation steps#1527
Improve README with Quick Start guide and Graphviz installation steps#1527Aditya-Deshwal23 wants to merge 12 commits into
Conversation
|
@Aditya-Deshwal23 can you rebase the branch please? |
Aditya-Deshwal23
force-pushed
the
improve-readme-quickstart
branch
from
1f90f9a to
88e85a3
Compare
@skrawcz Rebased the branch as requested. Please review again. |
|
Hi @skrawcz, I’ve rebased the branch and addressed the feedback. Could you please take another look when you get a chance? Thanks! |
docs: update python version to 3.9+ Co-authored-by: Stefan Krawczyk <stefan@dagworks.io>
docs: add LLM workflows mention Co-authored-by: Stefan Krawczyk <stefan@dagworks.io>
|
Hi @skrawcz, I’ve addressed the requested changes and pushed the updates, including the Quick Start improvements and formatting fixes. |
Aditya-Deshwal23
left a comment
Aditya-Deshwal23
left a comment
There was a problem hiding this comment.
updated to use builder pattern and verified example runs correctly
I don't think so. Can you show it running? |
Updated the README to include module attachment and corrected code execution steps.
Aditya-Deshwal23
left a comment
Aditya-Deshwal23
left a comment
There was a problem hiding this comment.
updated to pass a module instead of name. I ran this in a notebook/Replit and it works. Does this look correct to you?
|
Hi @skrawcz, just following up on my PR. I’ve addressed the previous feedback and made the requested changes. Could you please take another look when you get a chance? Thanks! |
|
Hi @skrawcz, hope you're doing well. Just following up on this PR again whenever you get a chance. I’d appreciate any further feedback or review. Thanks! |
|
Hi @skrawcz, I’ve resolved the merge conflicts and synced the branch with the latest main. Updates in this PR: Updated Documentation: Refined the Graphviz installation instructions. Addressed Feedback: Incorporated your previous suggestions regarding the builder pattern/import usage and applied the necessary formatting fixes. Whenever you have time, please feel free to take another look no rush at all. Thanks again for all the guidance and feedback throughout this process. |
2 participants
Summary
Added a Quick Start section and improved Graphviz installation instructions in the README.
Motivation
The current README is comprehensive but lacks a minimal working example for beginners.
This change helps new users quickly understand how to use Apache Hamilton with a simple example.
Changes
Impact
Improves onboarding experience for new users and reduces setup friction.