Repository navigation
Modernize tooling and add VitePress docs - #7
Merged
Merged
Conversation
Replace prettier with oxfmt, bump TypeScript to v6, update oxlint to v1.48+ with config file, add VitePress documentation site, publish workflow (OIDC trusted publishing), and docs deployment workflow.
There was a problem hiding this comment.
Pull request overview
This PR modernizes the repo’s tooling/workflows (TypeScript, lint/format, CI) and introduces a VitePress documentation site with GitHub Pages deployment, while slimming the README to point users to the hosted docs.
Changes:
- Replace Prettier with
oxfmt, addoxlintconfig, update TS/tooling versions and scripts. - Update CI workflows (Node 24, concurrency, build step), add publish workflow (OIDC provenance) and docs deploy workflow (Pages).
- Add VitePress docs site (getting started, usage, API) + custom theme/footer.
Reviewed changes
Copilot reviewed 18 out of 21 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
tsconfig.json |
Simplifies compiler options (adds Node types). |
README.md |
Replaces long-form README content with a brief intro + docs link. |
package.json |
Updates scripts/tooling dependencies; adds docs commands and metadata. |
docs/index.md |
Adds VitePress home page content. |
docs/getting-started.md |
Adds installation + introductory examples. |
docs/usage.md |
Adds usage guide (errors, throttling, examples, best practices). |
docs/api.md |
Adds API reference documentation. |
docs/.vitepress/config.mts |
Adds VitePress site config (sidebar, sitemap, canonical URLs). |
docs/.vitepress/theme/* |
Adds custom theme layout + CSS. |
.github/workflows/checks.yml |
Updates checks workflow (push on main, Node 24, build step, new lint command, concurrency). |
.github/workflows/docs.yml |
Adds GitHub Pages docs deployment workflow. |
.github/workflows/publish.yml |
Adds manual publish workflow with OIDC trusted publishing + release creation. |
.oxlintrc.json |
Adds oxlint configuration. |
.oxfmtrc.jsonc |
Adds oxfmt configuration. |
.oxfmtignore |
Adds oxfmt ignore list. |
.gitignore |
Ignores VitePress build/cache outputs. |
.editorconfig |
Adds consistent editor settings. |
.prettierrc.json |
Removes Prettier config (tooling migration). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Remove direct vite devDependency (only needed transitively via VitePress). Add radix parameter to parseInt in docs example.
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.

Replace prettier with oxfmt, bump to TypeScript v6 and oxlint v1.48+ with a config file, add editorconfig, and update the checks workflow (Node 24, concurrency group, build step).
Add VitePress documentation site with getting started, usage, and API reference pages. Add docs deployment workflow (GitHub Pages) and publish workflow (OIDC trusted publishing).
Slim down README to point to the docs site.
Scope: repo
Visibility: internal