-
Notifications
You must be signed in to change notification settings - Fork 162
Fold in MD in write-ups into docs #1405
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
base: main
Are you sure you want to change the base?
Conversation
docs/concepts/decorators.md
Outdated
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.
I think this is already in https://hamilton.apache.org/concepts/function-modifiers/ no? so could just be deleted? please check.
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.
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.
@does
, @parameterize_frame
, @model
are deprecated AFAIK. There's mention about it in the source code where these decorators are defined. It might preferable to not include them in the latest docs if deprecated
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.
ok
docs/get-started/basics.md
Outdated
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.
is this required with https://hamilton.staged.apache.org/get-started/your-first-dataflow/ ? what is missing?
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.
I rechecked basics.md, and it can be deleted.
Docs build fails with :
You can build them locally with https://github.com/apache/hamilton/blob/14143a504166fc10e9eac269fc377536ab36c2e5/docs/README.md |
This pull request resolves issue #1389 by integrating the content from the /writeups directory into /docs directory.
move the markdown files under hamilton/tree/main/writeups to hamilton/tree/main/docs
Changes
Content Migration: The informational content from various Markdown files within the /writeups directory has been moved to the /docs directory.
developer_setup.md -> docs/community
data_quality.md -> docs/concepts
decorators.md-> docs/concepts
/garbage_collection-> docs/concepts
basics.md-> docs/get-started
Directory Removal: The /writeups directory and its contents have been deleted, as they are now redundant.