Skip to content
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

Docs: Add structure to existing content #86

Merged
merged 2 commits into from
Jun 13, 2024
Merged

Conversation

vnikolova
Copy link
Collaborator

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 vnikolova requested a review from Mr3zee May 30, 2024 15:08
Copy link
Collaborator

@Mr3zee Mr3zee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, @vnikolova ! Thank you for the update!
I just want to suggest a bit restructuring the topics, like this:

  1. Get started
  2. Plugins
  3. Core concepts
    3.1. Services
    3.2. RPC Clients
    3.3. RPC Servers
  4. Protocols
    4.1 kRPC
    4.1.1 Configuration
    4.1.2 Features
    4.1.3 Transport
  5. Releases - release and versioning

The reason for such a structure, is that Configuration, Features (in their current way) and Transport are only applicable to kRPC protocol. Ans also there are plans for other protocols support, so we can add them to the Protocols section

Please tell me if this makes sense to you

@vnikolova
Copy link
Collaborator Author

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

Copy link
Collaborator

@Mr3zee Mr3zee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR!

@Mr3zee Mr3zee merged commit b9211a8 into main Jun 13, 2024
@Mr3zee Mr3zee deleted the vnikolova/docs-structure branch June 24, 2024 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants