Add Smithy Kotlin documentation#2944
Merged
kstich merged 5 commits intosmithy-lang:mainfrom Feb 3, 2026
Merged
Conversation
Contributor
|
This pull request does not contain a staged changelog entry. To create one, use the Make sure that the description is appropriate for a changelog entry and that the proper feature type is used. See |
kstich
reviewed
Jan 30, 2026
|
|
||
| kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "coroutines-core-version" } | ||
|
|
||
| Add the following dependencies to your project: |
Contributor
There was a problem hiding this comment.
I'd move this ahead of the version catalog.
|
|
||
| Some of the code generated client APIs are public but marked with an `InternalApi <https://github.com/smithy-lang/smithy-kotlin/blob/main/runtime/runtime-core/common/src/aws/smithy/kotlin/runtime/Annotations.kt#L8-L31>`_ | ||
| annotation to discourage client end users from using them outside of generated code. | ||
| To opt in to the InternalApi annotation, add the following to your Gradle build script: |
Contributor
There was a problem hiding this comment.
Suggested change
| To opt in to the InternalApi annotation, add the following to your Gradle build script: | |
| To opt in to the ``InternalApi`` annotation, add the following to your Gradle build script: |
kstich
approved these changes
Feb 3, 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.
Background
Added some Smithy Kotlin documentation to the smithy.io website. Smithy Kotlin is now GA and was missing documentation.
Testing
make install && make html && make serve./gradlew clean buildBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.