Skip to content

Improving documentation structure #1043

@zilto

Description

@zilto

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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomers

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions