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

V2: Extend documentation for descriptors #934

Merged
merged 1 commit into from
Jul 18, 2024

Conversation

timostamm
Copy link
Member

In the guide for writing plugins, we explain the descriptor hierarchy, and how to walk through it.

It's great, but now that descriptors are more prominent in v2, the hierarchy should be explained in the section about descriptors instead.

This PR adds

  • a description for every descriptor type
  • the section "Walking through a schema"
  • the section "Walking through message fields"
  • the section "Field descriptors"

As a follow-up, we can update the guide for writing plugins to condense it a little bit, and link to this new documentation where applicable.

@timostamm timostamm requested review from rakuista and smaye81 July 18, 2024 14:53
@timostamm timostamm changed the title Extend documentation for descriptors V2: Extend documentation for descriptors Jul 18, 2024
@timostamm timostamm merged commit ee20731 into v2 Jul 18, 2024
19 checks passed
@timostamm timostamm deleted the tstamm/Extend-documentation-for-descriptors branch July 18, 2024 15:22
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.

2 participants