Skip to content

ensure jsdocs check's dts is source of truth for docs examples.#1436

Merged
igalklebanov merged 3 commits intokysely-org:masterfrom
igalklebanov:update-docs
Apr 27, 2025
Merged

ensure jsdocs check's dts is source of truth for docs examples.#1436
igalklebanov merged 3 commits intokysely-org:masterfrom
igalklebanov:update-docs

Conversation

@igalklebanov
Copy link
Copy Markdown
Member

@igalklebanov igalklebanov commented Apr 22, 2025

Hey 👋

So we are testing our jsdocs code examples, and made changes to the examples. That's awesome.
To get that up and running, we created a d.ts file that contains all the types needed for our jsdocs examples.

I forgot to also make sure the docs site's examples' types are aligned with this new d.ts file.

This PR makes it so that the check's d.ts file is auto generated as the docs site's playground types.

Without these changes, the docs site's examples are broken and show lots of type errors.

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 22, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
kysely ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 27, 2025 2:23pm

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Apr 22, 2025

kysely_koa_example

npm i https://pkg.pr.new/kysely-org/kysely@1436

commit: 2f81643

@igalklebanov igalklebanov changed the title chore: update/fix docs. ensure jsdocs check's dts is source of truth for docs examples. Apr 22, 2025
@igalklebanov igalklebanov added bug Something isn't working documentation Improvements or additions to documentation labels Apr 22, 2025
@igalklebanov igalklebanov marked this pull request as ready for review April 22, 2025 09:23
@igalklebanov igalklebanov requested a review from koskimas April 22, 2025 09:26
Copy link
Copy Markdown
Member

@koskimas koskimas left a comment

Choose a reason for hiding this comment

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

LGTM!

@igalklebanov igalklebanov merged commit 52edd7e into kysely-org:master Apr 27, 2025
27 checks passed
@igalklebanov igalklebanov deleted the update-docs branch April 27, 2025 14:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants