Skip to content

[Docs]: Improve README with quick-start and architecture diagram #1558

@anjalimahajan2603

Description

@anjalimahajan2603

📜 Description

The README currently explains Julep at a high level but lacks:

  1. A clear "Quick Start" section for new users
  2. A system architecture diagram showing core components (agents, workflows, storage, execution engine)
  • Helps new contributors quickly understand the project structure

  • Reduces onboarding time for developers

  • Provides a visual overview of how workflows and agents interact

  • Add a "Quick Start" section with copy-paste commands

  • Include an architecture diagram (can be made in Excalidraw or Mermaid.js)

  • Link to advanced docs for deeper dives

👟 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