mathematic-inc / ts-japi

A highly-modular (typescript-friendly)-framework agnostic library for serializing data to the JSON:API specification
Apache License 2.0
201 stars 15 forks source link

[BUG] Documenation link broken #44

Open ntippie opened 2 years ago

ntippie commented 2 years ago

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*

Additional context

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

* means required.

evoactivity commented 6 months ago

@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.

jun-sheaf commented 6 months ago

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