Skip to content

Conversation

@Eunovo
Copy link
Contributor

@Eunovo Eunovo commented Oct 22, 2025

This PR contains an attempt to improve the design documentation to help new contributors to the repo. It adds more details about BuildField, ReadField and PassField. It explains how Callbacks, ThreadMaps and Async processing work.

@DrahtBot
Copy link

DrahtBot commented Oct 22, 2025

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Reviews

See the guideline for information on the review process.

Type Reviewers
Concept ACK Sjors
Stale ACK ryanofsky

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

LLM Linter (✨ experimental)

Possible typos and grammar issues:

  • resuse -> reuse [spelling error]
  • capabilites -> capabilities [spelling error]

drahtbot_id_5_m

@Eunovo Eunovo force-pushed the design-doc branch 2 times, most recently from 7756fdc to 459a730 Compare October 22, 2025 07:44
@ryanofsky
Copy link
Collaborator

@theuni you may be interested in this, it describes things like how callbacks can be implemented

@enirox001
Copy link

This is a helpful update. As someone getting familiar with this, the new details really helped clarify the design.

@Sjors
Copy link
Member

Sjors commented Oct 24, 2025

Concept ACK on expanding documentation, and thanks for adding these graphics.

Reviewer hint, switch to the rich diff:

Scherm­afbeelding 2025-10-24 om 12 10 06

@ryanofsky is probably best qualified to check correctness.

Copy link
Collaborator

@ryanofsky ryanofsky left a comment

Choose a reason for hiding this comment

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

Code review ACK 459a730. These updates are very good, and I think information about callbacks and context parameters should be especially helpful. I left a number of suggestions below, which can be addressed here or in a followup. You can let me know which you prefer.

@Eunovo
Copy link
Contributor Author

Eunovo commented Oct 28, 2025

Thanks for the review @ryanofsky . I made the suggested changes.

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.

5 participants