-
Notifications
You must be signed in to change notification settings - Fork 0
Add vocabulary normalization docs and updates #471
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
Open
leynos
wants to merge
2
commits into
main
Choose a base branch
from
add-vocabulary-normalization-docs-rbfae7
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+154
−24
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # Wireframe developers' guide | ||
|
|
||
| This guide defines the architectural vocabulary used across Wireframe source, | ||
| rustdoc, and user-facing documentation. Treat it as the naming contract for new | ||
| APIs and refactors. | ||
|
|
||
| ## Layer model and glossary | ||
|
|
||
| | Layer | Canonical term | Primary types | Description | | ||
| | --------------------- | ----------------- | ------------------------------------------------ | ----------------------------------------------------------------------------------- | | ||
| | Transport framing | Frame | `FrameCodec::Frame`, `LengthDelimitedFrameCodec` | Physical wire unit read from or written to the socket. | | ||
| | Routing envelope | Packet / Envelope | `Packet`, `Envelope`, `PacketParts` | Routable wrapper that carries route id, optional correlation id, and payload bytes. | | ||
| | Domain payload | Message | `message::Message`, extractor `Message<T>` | Typed application data encoded into packet payload bytes. | | ||
| | Transport subdivision | Fragment | `FragmentHeader`, `Fragmenter`, `Reassembler` | Size-limited chunk used when a payload exceeds frame budget. | | ||
|
|
||
| ## Naming invariants | ||
|
|
||
| - Frame terms belong to codec and socket boundaries only. | ||
| - Packet or envelope terms belong to routing and middleware request/response | ||
| wrappers. | ||
| - Message terms belong to typed payload encode/decode concerns. | ||
| - Fragment terms belong to transport splitting and reassembly. | ||
| - Correlation identifiers are cross-layer metadata and may appear on frame, | ||
| packet, and message-adjacent APIs when protocol metadata requires it. | ||
|
|
||
| ## Allowed aliases and prohibited mixing | ||
|
|
||
| | Canonical term | Allowed aliases | Avoid in the same context | | ||
| | ----------------- | ---------------------------- | ----------------------------------------- | | ||
| | Frame | wire frame, transport frame | packet, envelope, message | | ||
| | Packet / Envelope | routable envelope | frame (unless describing codec transport) | | ||
| | Message | payload type, domain message | frame, fragment | | ||
| | Fragment | fragment chunk | packet, message | | ||
|
|
||
| ## API and docs checklist | ||
|
|
||
| Use this checklist before merging API naming changes: | ||
|
|
||
| - Confirm the identifier name matches the owning layer. | ||
| - Ensure rustdoc examples use the same term as the symbol being documented. | ||
| - Verify `docs/users-guide.md` and migration notes describe the same meaning. | ||
| - Label cross-layer terms (for example, `correlation_id`) explicitly as shared | ||
| metadata. | ||
|
|
||
| ## Vocabulary normalization outcome (2026-02-20) | ||
|
|
||
| The 2026-02-20 normalization pass aligned docs and rustdoc terminology to this | ||
| model and did not rename public symbols. Existing API names (`FrameCodec`, | ||
| `Packet`, `Envelope`, `Message`, `Fragment*`) already map cleanly to separate | ||
| layers, so the implementation focused on clarifying boundaries rather than | ||
| introducing additional breaking changes. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use -ize spelling for serialization terms.
Replace "serialisation" and "deserialisation" with "serialization" and
"deserialization" to match en-GB-oxendict spelling.
✏️ Proposed fix
As per coding guidelines, Comments and docs must follow en-GB-oxendict (-ize / -yse / -our) spelling and grammar.
📝 Committable suggestion
🤖 Prompt for AI Agents