docs: How to add a new protocol — interactive onboarding track#3
Draft
yasmewad wants to merge 1 commit into
Draft
docs: How to add a new protocol — interactive onboarding track#3yasmewad wants to merge 1 commit into
yasmewad wants to merge 1 commit into
Conversation
Seven-lesson interactive track teaching the smithy-java client architecture through the lens of adding a protocol. Each lesson is a self-contained HTML file with an interactive self-check, plus a non-interactive Markdown companion. Includes a landing page, a shared glossary, and walkthrough media (GIF + MP4 + posters). Documentation only; no production code paths touched.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
Adds a seven-lesson interactive onboarding track — How to add a new protocol to smithy-java —
that teaches the client architecture through one concrete task. A protocol touches every layer
(the
ClientProtocolcontract, schema-directed serde, codecs, SPI discovery, the HTTP baseclasses, compliance tests), so working through it end-to-end is a guided tour of the whole framework.
Each lesson is a self-contained HTML file with an interactive self-check (instant feedback),
backed by a Markdown companion for static reading, plus a landing page and a shared glossary.
Landing page
Walkthrough (animated)
🎬 Full 64s screen recording touring all seven lessons + the interactive quizzes:
docs/media/protocol-track-walkthrough.mp4(MP4 links download from a repo path; GitHub only shows an inline player when the file is
drag-dropped into the PR. To embed the player, drag the file from
docs/media/into this box.)Single-lesson recording (Lesson 1) — GIF
The track
ClientProtocolContractclient.call(...).RpcV2CborProtocolin ~45 lines — contract satisfied by inheritance.Schemaas the contract.Codecis; reuse vs write; protocol-axis vs codec-axis.SchemaExtensionProvider+ServiceLoader/META-INF/services.HttpClientProtocol) vs REST (HttpBindingClientProtocol).Start at
docs/lessons/index.html. Prefer reading? Every lesson has a.mdtwin beside it.Files
Accuracy
All signatures and file paths are quoted verbatim from the codebase:
ClientProtocol,ClientProtocolFactory,ProtocolSettings,MessageExchange,HttpClientProtocol,HttpBindingClientProtocol,RpcV2CborProtocol/AbstractRpcV2ClientProtocol,RestJsonClientProtocol, theAwsJson*/AwsQuery*/RestXmlclass declarations,ShapeSerializer,Codec,SchemaExtensionProvider/SchemaExtensionKey,DetectProtocolPlugin,ProtocolTest, and the realMETA-INF/servicesregistrations.Notes for reviewers
hosted as a release asset / Git LFS instead of committed to the tree.