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-2595] Reorganize JS driver README #249

Merged
merged 1 commit into from
Mar 28, 2024
Merged

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Mar 27, 2024

Ticket(s): DOCS-2595

Problem

The current JavaScript driver README introduces concepts in a somewhat confusing order. It also has some minor grammar/styling issues.

Solution

Out of scope

  • Overhauling the client configuration section. We can likely simplify this into a table.
  • Documenting all supported types for TypeScript

Testing

I tested all updated snippets


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

@cleve-fauna cleve-fauna left a comment

Choose a reason for hiding this comment

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

Thanks James!

@cleve-fauna cleve-fauna merged commit 4f90004 into main Mar 28, 2024
5 checks passed
@cleve-fauna cleve-fauna deleted the reorganize-js-readme branch March 28, 2024 17:12
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