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

Improve Documentation #44

Open
NikhilNarayana opened this issue Dec 9, 2020 · 3 comments
Open

Improve Documentation #44

NikhilNarayana opened this issue Dec 9, 2020 · 3 comments

Comments

@NikhilNarayana
Copy link
Member

NikhilNarayana commented Dec 9, 2020 •
edited
Loading

Right now there is no direct documentation about the inner workings of slippi-js. It takes a decent bit of effort for devs to familiarize themselves with the SLP spec and the various tools provided by slippi-js. It would be ideal to have a central location for most of this info (linking back to the spec for deeper explanations would be acceptable).
@b3nd3r-ssbm
Copy link

I'm working on getting the info together, rn I have the SlippiGame object and its functions

@Gaurav-Iyer
Copy link

Has this documentation been pushed up anywhere, I couldn't seem to find it.

@NikhilNarayana
Copy link
Member Author

Has this documentation been pushed up anywhere, I couldn't seem to find it.

nothing has been pushed anywhere to my knowledge or been reviewed for accuracy. for now asking in our discord's dev-support channel is a fine method to figure out what you need

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@NikhilNarayana @Gaurav-Iyer @b3nd3r-ssbm