-
Notifications
You must be signed in to change notification settings - Fork 30
Documentation update for 0.8.0 #351
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
Conversation
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.
Pull Request Overview
Updates documentation and adds a migration guide for version 0.8.0, aligning examples and APIs with the latest library changes.
- Revamped many topic files to reflect breaking changes, new DSLs, and removal of deprecated APIs.
- Introduced dedicated
krpc-client.topic
andkrpc-server.topic
, and reorganized the navigation tree. - Enhanced KDoc in core APIs (
withService
,RpcServer
,RpcClient
,RpcCall
) and addedderegisterService
.
Reviewed Changes
Copilot reviewed 29 out of 29 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
docs/pages/kotlinx-rpc/topics/transport.topic | Clean up transport docs, update chapter titles and wording |
docs/pages/kotlinx-rpc/topics/strict-mode.topic | Clarify strict-mode wording, remove deprecated Gradle section |
docs/pages/kotlinx-rpc/topics/services.topic | Remove RemoteService , adjust code examples and paragraph tags |
docs/pages/kotlinx-rpc/topics/rpc-servers.topic | Simplify registration examples, note deregistration support |
docs/pages/kotlinx-rpc/topics/rpc-clients.topic | Refine client stub description, remove outdated DSL, add tip |
docs/pages/kotlinx-rpc/topics/plugins.topic | Add rpc extension section, wrap notes in <note> |
docs/pages/kotlinx-rpc/topics/krpc-server.topic | New Ktor server integration doc |
docs/pages/kotlinx-rpc/topics/krpc-ktor.topic | New Ktor transport doc with examples |
docs/pages/kotlinx-rpc/topics/krpc-client.topic | New Ktor client integration doc |
docs/pages/kotlinx-rpc/topics/features.topic | Update streaming examples, remove RemoteService from interfaces |
docs/pages/kotlinx-rpc/topics/configuration.topic | Rewrite DSL examples, improve grammar |
docs/pages/kotlinx-rpc/topics/annotation-type-safety.topic | Extend annotation type-safety examples |
docs/pages/kotlinx-rpc/topics/0-8-0.topic | Add comprehensive migration guide for 0.8.0 |
docs/pages/kotlinx-rpc/rpc.tree | Update site navigation to include new and moved topic files |
core/src/commonMain/kotlin/kotlinx/rpc/withService.kt | Enhance KDoc for withService overloads |
core/src/commonMain/kotlin/kotlinx/rpc/annotations/Rpc.kt | Expand examples in @Rpc annotation docs |
core/src/commonMain/kotlin/kotlinx/rpc/annotations/CheckedTypeAnnotation.kt | Improve @CheckedTypeAnnotation KDoc |
core/src/commonMain/kotlin/kotlinx/rpc/RpcServer.kt | Add KDoc for deregisterService , tweak registerService docs |
core/src/commonMain/kotlin/kotlinx/rpc/RpcClient.kt | Remove outdated CoroutineScope import, polish KDoc |
core/src/commonMain/kotlin/kotlinx/rpc/RpcCall.kt | Clarify KDoc wording for RpcCall properties |
Comments suppressed due to low confidence (3)
docs/pages/kotlinx-rpc/topics/rpc-clients.topic:23
- This link points to
grpc-services.topic
, which doesn’t exist. Update it to the correct gRPC services documentation or remove the reference.
See <a href="grpc-services.topic"/>.
docs/pages/kotlinx-rpc/topics/rpc-servers.topic:43
- The
<a>
tag is self-closing and has no link text. Wrap the URL in a descriptive link (e.g.,<a href="annotation-type-safety.topic">annotation type-safety guide</a>
).
See <a href="annotation-type-safety.topic"/> for more details.
docs/pages/kotlinx-rpc/topics/krpc-ktor.topic:121
- There's a typo in the parameter type — it should be
String
, notSrting
.
override suspend fun processImage(url: Srting): ProcessedImage
17d8c5c
to
fbd4c6e
Compare
b783fcb
to
0a0d4bb
Compare
fbd4c6e
to
3b32e1e
Compare
0a0d4bb
to
125f9ea
Compare
Strict mode Migration
A series of changes to simplify kRPC protocol
Subsystem
Kdocs, documentation
Problem Description
A lot of changes in 0.8.0 make most of the docs outdated.
Solution
Update API docs, examples, documentation website, and provide a migration guide.