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

Document all existing scripting API #6

Open
3 tasks
kraifpatrik opened this issue Sep 29, 2024 · 2 comments
Open
3 tasks

Document all existing scripting API #6

kraifpatrik opened this issue Sep 29, 2024 · 2 comments
Assignees
@kraifpatrik
Labels
documentation Improvements or additions to documentation

Comments

@kraifpatrik
Copy link
Member

kraifpatrik commented Sep 29, 2024 •
edited
Loading

None of the API is currently documented - this needs to be fixed! Both for people to be able to use the library + for joining us in developing the system further.

  • Basic scripting API docs
  • Example code in docs where appropriate
  • "Getting started" section in docs
@kraifpatrik kraifpatrik added the documentation Improvements or additions to documentation label Sep 29, 2024
@kraifpatrik kraifpatrik self-assigned this Sep 29, 2024
@kraifpatrik
Copy link
Member Author

By commit 6a3693d this is now mostly done. We should still add some example code here and there, but showing how to use the library should be handled through a "Getting started" section in the docs (TODO).

@kraifpatrik
Copy link
Member Author

Added some new stuff without docs, so I'm unchecking the scripting API checkbox again 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kraifpatrik kraifpatrik

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kraifpatrik