apache / apache/hamilton

Improving documentation structure

Open
#1,043 3 comments 0 reactions 0 assignees View on GitHub
documentation enhancement good first issue
Dominant language
Jupyter Notebook
Stars
2.6k
Forks
213
PR merge metrics
No merged PRs in 30d

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!

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)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.