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: Added JS API Documentation #38

Merged
merged 1 commit into from
Mar 17, 2024
Merged

Docs: Added JS API Documentation #38

merged 1 commit into from
Mar 17, 2024

Conversation

freehuntx
Copy link
Contributor

@freehuntx freehuntx commented Mar 16, 2024

What's new

I created an documentation for the JavaScript api. Its not finished yet and still WIP but i think any documentation is better than none. This makes sure we already have a place for further documentation and we can give people the link to the doc instead of telling them to look in the code.

  • Created file: documentation/JavaScript.md

For the reviewer

Its still WIP but all methods are already listed. So its still useful.

  • I've uploaded the firmware with this patch to a device and verified its functionality
  • I've confirmed the bug to be fixed / feature to be stable

@Willy-JL
Copy link
Member

thanks! will keep adding in the future, also possibly specifying what is in OFW and what isn't, but thisis a great start!

@Willy-JL Willy-JL merged commit 6f9e50d into Next-Flip:dev Mar 17, 2024
2 checks passed
@Willy-JL Willy-JL added the enhancement New enhancement or request label Mar 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New enhancement or request
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants