Skip to content

Conversation

wenrizc
Copy link

@wenrizc wenrizc commented Oct 9, 2025

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.

Copy link
Contributor

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.

Copy link
Author

Choose a reason for hiding this comment

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

Compared to decorators.md, function-modifiers.rst is missing @does, @parameterize_frame, @model. Should I integrate them into function-modifiers.rst?Also, the introduction for @subdag can be added to function-modifiers-advanced.rst.

Copy link
Contributor

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

Copy link
Author

Choose a reason for hiding this comment

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

ok

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Author

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.

@skrawcz
Copy link
Contributor

skrawcz commented Oct 10, 2025

Docs build fails with :

/home/runner/work/hamilton/hamilton/docs/community/developer_setup.md:74: WARNING: 'myst' cross-reference target not found: 'how-to-run-unit-tests' [myst.xref_missing]
/home/runner/work/hamilton/hamilton/docs/concepts/decorators.md:3: WARNING: 'myst' cross-reference target not found: 'hamilton/function_modifiers.py' [myst.xref_missing]
/home/runner/work/hamilton/hamilton/docs/concepts/decorators.md:422: WARNING: 'myst' cross-reference target not found: 'examples/reusing_functions/reusable_subdags.py' [myst.xref_missing]
/home/runner/work/hamilton/hamilton/docs/concepts/garbage_collection/post.md:13: WARNING: 'myst' cross-reference target not found: 'www.tryhamilton.dev' [myst.xref_missing]
/home/runner/work/hamilton/hamilton/docs/get-started/basics.md:90: WARNING: 'myst' cross-reference target not found: '/hamilton/driver.py' [myst.xref_missing]

You can build them locally with https://github.com/apache/hamilton/blob/14143a504166fc10e9eac269fc377536ab36c2e5/docs/README.md

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.

3 participants