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

Add proper documentation #38

Open
pepperoni21 opened this issue Apr 8, 2024 · 2 comments
Open

Add proper documentation #38

pepperoni21 opened this issue Apr 8, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@pepperoni21
Copy link
Owner

pepperoni21 commented Apr 8, 2024

Currently the only documentation we have is through the README.md and the examples folder (which do not cover everything btw).

We should add some proper documentation that illustrates each binding/feature of the lib inside a docs folder.

I don't really have time to do that currently so if someone's down to do it let me know!

@pepperoni21 pepperoni21 added the documentation Improvements or additions to documentation label Apr 8, 2024
@pepperoni21 pepperoni21 added the good first issue Good for newcomers label Jun 23, 2024
@Madoshakalaka
Copy link

Some items are missing on docs.rs, like the send_function_call function, the FunctionCallRequest struct etc. I think some feature flags were missing during the doc generation?

@boydjohnson
Copy link
Contributor

boydjohnson commented Nov 3, 2024

This explains how to include optional features in docs.rs builds. I will have a PR up soon that includes all features in the docs.rs builds.

https://users.rust-lang.org/t/how-to-document-optional-features-in-api-docs/64577

==============

See #84

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants