Skip to content

[Docs]: Refresh README to focus on users #248

@ConnorKirk

Description

@ConnorKirk

Issue

Currently the repository readme is an architectural overview of the SDK. This is useful for contributors, but not helpful for users interested in using the SDK.

Page/Location

README.md

Suggested Fix

Instead, I think the README should have:

  • A description of what this repository is, and what durable executions are
  • Link to the developer guide, marketing page and pypi page
  • Quickstart example (can copy from existing stuff)
    The architectural overview could be moved elsewhere

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions