Tasks

[wayofthefuture]

@HarelM Tasks:

• ci tests on pull requests
• docs page
• coverage 100% and coverage badge on readme.md
• codecov & badge on readme
• finish undefined values in _cleanDecoded
• replace _functionName with private functionName

[wayofthefuture]

I think the guide should be a button on the docs page - maybe at the top near the badges. Otherwise search won't bring more community.. I also invited the original creator of the guide to be a collaborator as well. It became hard to use the guide when they moved it a while back

[HarelM]

I'm not sure where the docs are pointing to, but I don't have access to change it.

I've added the API into the docs folder when building, I'm guessing the current docs can be updated to link to the API docs if needed, or it can be the other way around where the API docs are the "initial" docs and adding a link to the spec can be added from there. It's easy to add an external link to typedoc.

[wayofthefuture]

Does this help?

[HarelM]

API documentation is generated "on the fly" so merging it to main it's a great practive.
I usually build it on main and publish it to github pages using an action.

[wayofthefuture]

So do I need to change anything? I can't find the setting to increase your permissions

[HarelM]

You can't add more permissions on personal repos, just those belong to organization.
Charge the setting of docs to use gh-pages branch and I'll take the from there.

[wayofthefuture]

Done

[HarelM]

Opened a PR to address docs publishing here:

• Publish docs with CI #4

I've marked the PR to close this issue, @wayofthefuture if this is not the case do let me know or update the PR comment.