fauna / fauna-js

Javascript driver for Fauna v10 (current)
https://fauna.com
Other
37 stars 7 forks source link

[DOCS-3194] Generate API docs for JS driver #282

Closed jrodewig closed 3 months ago

jrodewig commented 3 months ago

Ticket(s): DOCS-3194

IMPORTANT: I don't have access to Concourse pipelines so I'll need someone to test those changes for me.

Problem

We don't currently publish API reference for the v10 JavaScript/TypeScript driver.

During recent onboarding interviews, some customers have requested these docs.

Solution

Result

The API docs will be available at https://fauna.github.io/fauna-js/.

I've already backfilled docs for the current release (2.2.0) in the gh-pages branch, but I'm holding off on publication until this PR is approved.

Testing

I've manually tested by running npm install && npm run doc to generate the files.

I don't have access to Concourse pipelines so I'll need someone to test those changes for me.


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

jrodewig commented 3 months ago

Sounds good to me. Thanks @pnwpedro!