Skip to content

[Refactor]: Enhance README with structured overview, usage examples, and visuals #1555

@anjalimahajan2603

Description

@anjalimahajan2603

📜 Description

The current README offers a brief introduction, but could be improved by:

  • Adding a clear Table of Contents
  • Including example code snippets (YAML workflows, CLI usage)
  • Embedding visual diagrams (e.g., agent/workflow architecture)
  • Highlighting key features like memory, branching, tool integration
  • Streamlining developer onboarding steps (clone, setup, test)

These updates will make it easier for new contributors to understand and engage with the platform.

👟 Relevant files

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions