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.

Sign up for GitHub

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

Jump to bottom

Add appendix with lower-level type definitions #82

Open
arnoweiss opened this issue Dec 4, 2024 · 0 comments
Open

Add appendix with lower-level type definitions #82

arnoweiss opened this issue Dec 4, 2024 · 0 comments

Comments

@arnoweiss
Copy link
Contributor

Feature Request

top-level message formats should be included in the protocol chapters directly while

Which Areas Would Be Affected?

message definitions

Type: non-normative

Why Is the Feature Desired?

strike balance between avoiding jumps and readibility

Solution Proposal

  • Define terms in "Terms and definitions" section
  • Define top-level message payloads in inline tables
  • Define lower-level embedded objects in appendix
  • Link from terms and messages to appendix if applicable
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@arnoweiss