Skip to content
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

Improving documentation structure #1043

Open
zilto opened this issue Jul 19, 2024 · 0 comments
Open

Improving documentation structure #1043

zilto opened this issue Jul 19, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@zilto
Copy link
Collaborator

zilto commented Jul 19, 2024

As Hamilton and its documentation are growing, the documentation requires additional structure. Here are a few tasks to improve the documentation, please comment on this issue if you're interested in undertaking one!

  1. The Integrations section could be refactored to "Plugins" (i.e., libraries that Hamilton has extensions for) and "Cookbook" (i.e., examples on how to use FastAPI and Hamilton)
  2. The API reference section should have a section about plugins
  3. The Lifecycle Adapters section should separate the lifecycle API (i.e., GraphExecutionHook, NodeExecutionMethod, etc.) from the actual adapter implementations (SlackNotifier, ProgressBar)
@zilto zilto added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Jul 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant