Update README for Developer Preview - #85
Open
Alan4506 wants to merge 3 commits into
Open
Conversation
Alan4506
force-pushed
the
update-readme
branch
from
August 20, 2026 22:21
db9ce0b to
7a648e6
Compare
alexgromero
reviewed
Aug 21, 2026
alexgromero
left a comment
alexgromero
left a comment
Contributor
There was a problem hiding this comment.
Overall this looks good! I think we could tweak the flow a bit to get users to the Quick start sooner. It might read more naturally as intro --> installation --> Quick start --> additional setup/details like bidirectional streaming.
alexgromero
reviewed
Aug 21, 2026
alexgromero
approved these changes
Aug 21, 2026
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
2 participants
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.
Description of changes:
Updates the root README for the Developer Preview:
Note: content reflects the final dev preview release state. Changes such as smithy-lang/smithy-python#765 has not been released yet. The developer guide has not been published yet as well. We should merge this PR only after all those changes land. At that time we'll update the "About" section of the repo as well.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.