ts-japi icon indicating copy to clipboard operation
ts-japi copied to clipboard

[BUG] Documenation link broken

Open ntippie opened this issue 2 years ago • 2 comments

Describe the bug*

The documentation link in the README returns a 404.

To Reproduce*

HTTP GET https://mathematic-inc.github.io/ts-japi/

Expected behavior*

Able to easily access documentation from README

Screenshots

n/a

Platform*

  • [ ] OS: {{ Write the OS name and its version }}
  • [X] Browser {{ Write the browser name and its version }}
  • [ ] Version: {{ Write the package version }}

Additional context

Docs seem to be available at https://github.com/mathematic-inc/ts-japi/tree/main/docs/api

* means required.

ntippie avatar Jul 05 '22 18:07 ntippie

@jun-sheaf I've got an example workflow running and deploying to github pages using TSDoc https://evoactivity.github.io/ts-japi

If you are happy for me to switch to this strategy I'll put together a PR.

evoactivity avatar Feb 10 '24 03:02 evoactivity

Looks good to me! Send a PR my way :)

jrandolf avatar Feb 10 '24 09:02 jrandolf