Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Aug 12, 2024
Merged

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Aug 9, 2024

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

  • Use TypeDoc to generate API reference from TypeScript source and comments.
  • Incorporate publication into the Concourse pipeline
  • Host the docs on GH pages (via the 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.

Copy link
Contributor

@pnwpedro pnwpedro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Since the doc publishing is after publishing, we'll have to test the pipeline after merge and flush, which is fine I think. If it ends up failing, we can iterate with a dummy pipeline to get it right and PR the fix once.

@jrodewig
Copy link
Contributor Author

Sounds good to me. Thanks @pnwpedro!

@jrodewig jrodewig merged commit 618944b into main Aug 12, 2024
5 checks passed
@jrodewig jrodewig deleted the generate-typedoc branch August 12, 2024 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants