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

Write Documentation for the JS Lib API and the Core API #72

Closed
torch2424 opened this issue Apr 16, 2018 · 1 comment
Closed

Write Documentation for the JS Lib API and the Core API #72

torch2424 opened this issue Apr 16, 2018 · 1 comment
Assignees
Labels
Core/Wasm Issues concerning the core library of Wasmboy enhancement New feature or request Lib / JS Issues concerning the JS API of WasmBoy

Comments

@torch2424
Copy link
Owner

torch2424 commented Apr 16, 2018

Also related to #65

Since we are about to start wrapping things up. We should try to write docs for the API that we should have, and then refactor the code accordingly. That way we can get some other eyes on the API, and names and things, and then implement all at once.

The old current API, can be preserved in the index.ts, by exporting the new API with the old naming :)

Also, decided to use github wikis for docs. Since, it is probably most well know, git books are kind of confusing for me to navigate (personally), and doing the monolithic/documentation directory approach
that create-reat-app follows is kind of awkward for navigating, and sometimes finding things.

@torch2424 torch2424 added enhancement New feature or request Core/Wasm Issues concerning the core library of Wasmboy Lib / JS Issues concerning the JS API of WasmBoy labels Apr 16, 2018
@torch2424 torch2424 self-assigned this Apr 16, 2018
@torch2424
Copy link
Owner Author

This is now in the wiki 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Core/Wasm Issues concerning the core library of Wasmboy enhancement New feature or request Lib / JS Issues concerning the JS API of WasmBoy
Projects
None yet
Development

No branches or pull requests

1 participant