search

Kotlin / kotlinx-rpc

Add asynchronous RPC services to your multiplatform applications.
https://kotlin.github.io/kotlinx-rpc/
Apache License 2.0
512 stars 7 forks source link

Docs: Add structure to existing content #86

Closed vnikolova closed 2 weeks ago

vnikolova commented 1 month ago

Subsystem Docs

Problem Description Currently there's only a large Getting started topic in docs.

Solution Split up the document into separate XML topics.

  1. Get started - includes an introduction to the library and an installation guide
  2. Plugins - explains the differences between the two plugins provided by the library
  3. Core concepts - the main concepts and terminology explained with relation to the API 3.1. Services 3.2. RPC Clients 3.3. RPC Servers 3.4. Transport
  4. Configuration - usage of RPCConfig
  5. Features - send and receive flows, service fields, field declarations
  6. Releases - release and versioning

Can you please check if this structure makes sense?

vnikolova commented 3 weeks ago

@Mr3zee thank you for clarifying. It makes perfect sense!