Skip to content

Roadmap: add usage examples to the docs #2

Description

@rehan243

To improve the usability of Agentic-AI-Workflows, I'm proposing the following roadmap item: adding usage examples to the documentation.

Motivation

The current documentation provides a good overview of the available features, but lacks concrete examples that demonstrate how to effectively use the library in real-world scenarios. This makes it difficult for new users to get started and understand the practical applications of the project.

Proposed approach

To address this, I plan to:

  • Develop examples that cover common use cases, such as integrating with popular LLMs and fine-tuning with LoRA/QLoRA.
  • Include code snippets and explanations that highlight key configuration options and best practices.
  • Organize the examples in a dedicated section of the documentation, making it easy for users to find and reference them.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions