-
Notifications
You must be signed in to change notification settings - Fork 180
Improving documentation structure #1043
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomers
Description
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!
- The
Integrationssection 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) - The API reference section should have a section about plugins
- The
Lifecycle Adapterssection should separate the lifecycle API (i.e., GraphExecutionHook, NodeExecutionMethod, etc.) from the actual adapter implementations (SlackNotifier, ProgressBar)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomers
Type
Fields
Give feedbackNo fields configured for issues without a type.