Request for API Documentation

[bilalba]

Feature Request

Is your feature request related to a problem? Please describe:
Currently, the complete API features are only defined in the ProtoBuf Service Definition
There is no user-friendly way to know all the different API's, the arguments they expect and the output. The language specific documentation is also sparse, and only shows how to use the ExecProgram API.

Describe the feature you'd like:
A human-readable formatted list of the API's along with the arguments and the output. A link to that in the SDK documentation.

Describe alternatives you've considered:
I spent time reading the Python SDK and found out that the Python SDK is based on the Rust SDK. However, even the RUST SDK does not document all the SDK APIs. I only found details on them here.
ProtoBuf Service Definition

Teachability, Documentation, Adoption, Migration Strategy:
Good documentation will help with adaptability and make it users from different language SDK be able to quickly onboard onto KCL.

[Peefy]

@bilalba Thank you for your feedback.

We are planning to migrate the documents in Protobuf API to different languages and provide corresponding examples and documents.

Of course, the API parameters of different SDKs are the same. I am translating the examples in protobuf to more SDKs through AI, adding them to unit tests and providing documents. For example, the tests and examples of Python SDK are in: https://github.com/kcl-lang/lib/tree/main/python/tests The testing and examples of Java SDK are available at: https://github.com/kcl-lang/lib/tree/main/java/src/test/java/com/kcl

Also, are you interested in contributing? We welcome any form of issue suggestions and PRs ❤️ We expect to provide documentation and examples for all SDKs before next weekend.

[Peefy]

More Code Examples

• Python feat: add more python examples and pyi files lib#108
• .NET feat: add all dotnet API tests and reference docs lib#114
• Java feat: add all Java API tests and reference docs lib#111
• Node.js feat: add all node.js API tests and reference docs lib#112
• Rust feat: add all Rust API reference docs lib#113

More Documents

• Python docs: add python API reference docs kcl-lang.io#412
• .NET docs: add dotnet API reference docs kcl-lang.io#416
• Java docs: add java API reference docs kcl-lang.io#413
• Node.js docs: add node.js API reference docs kcl-lang.io#414
• Rust docs: update rust and wasm api reference documents kcl-lang.io#415