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.

Sign up for GitHub

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

Jump to bottom

Update documentation #4

Open
lmoe opened this issue Jan 23, 2024 · 0 comments
Open

Update documentation #4

lmoe opened this issue Jan 23, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@lmoe
Copy link
Collaborator

lmoe commented Jan 23, 2024

The current documentation is too short and should be rewritten.
It should contain a proper introduction, a description about its use case and lead to the iota-sdk documentation.

Furthermore, native interop caveats such as free'ing, memory leaks and memory safety needs to be pointed out a bit more prominently.
@lmoe lmoe added the documentation Improvements or additions to documentation label Jan 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@lmoe