[DOCS-3194] Generate API docs for JS driver #282
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.