Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

User guide documentation updates #629

Closed
wants to merge 11 commits into from
Closed

Conversation

akshat2602
Copy link
Contributor

@akshat2602 akshat2602 commented Jun 22, 2024

Description

Added some examples to the user guide and removed some redundant and out of date information. There are some changes still remaining, hence the draft PR. Fixes #599 #600 #601 #602

Type of change

  • Documentation change (pure documentation change)

What's Changed

  • User Guide documentation updates

Copy link

vercel bot commented Jun 22, 2024

@akshat2602 is attempting to deploy a commit to the Hatchet Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Jun 22, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hatchet-docs ❌ Failed (Inspect) Jul 9, 2024 10:32pm

@akshat2602
Copy link
Contributor Author

This is still missing changes for scheduling workflows, needs discussion.

@akshat2602 akshat2602 marked this pull request as ready for review June 25, 2024 17:38
Copy link
Contributor

@grutt grutt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice! some small changes

@hatchet.step()
def spawn(self, context: Context):
for i in range(10):
context.spawn_workflow(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@abelanger5 do we want to document the aio client here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The aio client is mentioned in the scatter gather workflows further down, we can expand on it there as well.

@akshat2602
Copy link
Contributor Author

Hey @abelanger5, can you review now? I've updated the branch with the suggestions.

@grutt
Copy link
Contributor

grutt commented Jul 10, 2024

Will Track this in #705

@grutt grutt closed this Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Missing typescript examples in user-guide
4 participants