Skip to content

Minor docs change #1302

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

Merged
merged 1 commit into from
Aug 17, 2023
Merged

Minor docs change #1302

merged 1 commit into from
Aug 17, 2023

Conversation

drwpow
Copy link
Contributor

@drwpow drwpow commented Aug 17, 2023

Changes

Adds a note about noUncheckedIndexedAccess in the setup section, and links to the TS docs in the extended passage

How to Review

Docs-only change; no code changes

Checklist

  • Unit tests updated
  • docs/ updated (if necessary)
  • pnpm run update:examples run (only applicable for openapi-typescript)

@changeset-bot
Copy link

changeset-bot bot commented Aug 17, 2023

⚠️ No Changeset found

Latest commit: 60a9de3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Aug 17, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 60a9de3
Status:⚡️  Build in progress...

View logs

@drwpow drwpow marked this pull request as ready for review August 17, 2023 07:10
## Usage
## Setup

This library requires the latest version of <a href="https://nodejs.org/en" target="_blank" rel="noopener noreferrer">Node.js</a> installed (20.x or higher recommended). With that present, run the following in your project:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

🤔 Just noticed this section was missing from the README.

@drwpow drwpow merged commit b81a8a0 into main Aug 17, 2023
@drwpow drwpow deleted the docs-update branch August 17, 2023 07:16
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.

1 participant