Closed jrodewig closed 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.
We don't currently publish API reference for the v10 JavaScript/TypeScript driver.
During recent onboarding interviews, some customers have requested these docs.
gh-pages
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.
I've manually tested by running npm install && npm run doc to generate the files.
npm install && npm run doc
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.
Sounds good to me. Thanks @pnwpedro!
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
gh-pages
branch).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.