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

Contributing to the documentation - Architecture #176

Merged
merged 1 commit into from
Jan 2, 2024

Conversation

zeu5
Copy link
Contributor

@zeu5 zeu5 commented Dec 29, 2023

Hello @guergabo!

I've taken an ambitious step of understanding and updating the documentation of Resonate codebase. Based on my understanding I've updated the following,

Changes:

  • Added information about the kernel subsystem in docs/architecture.md
  • A new figure describing the lifecycle of a coroutine in resonate

While this is a small step, I wish to use this as an opportunity to understand the requirements by the maintainers for the documentation. Hoping to improve with feedback!

}
```

For every `SQE` within the Kernel, there exists a corresponding `CQE` and the callback and metadata is shared between the two instances.
Copy link
Contributor

Choose a reason for hiding this comment

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

very nice insight here.

@guergabo guergabo merged commit 80a003b into resonatehq:main Jan 2, 2024
6 checks passed
@resonatehq resonatehq deleted a comment from codecov bot Jan 2, 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.

None yet

2 participants