Skip to content

Modernize tooling and add VitePress docs - #7

Merged
0x80 merged 2 commits into
mainfrom
thijs/0319-add-docs
Mar 19, 2026
Merged

0x80 merged 2 commits into
mainfrom
thijs/0319-add-docs

Conversation

@0x80

@0x80 0x80 commented Mar 19, 2026

Copy link
Copy Markdown
Owner

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

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.
Copilot AI review requested due to automatic review settings March 19, 2026 18:08

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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, add oxlint config, 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.

Comment thread package.json Outdated
Comment thread .github/workflows/publish.yml
Comment thread docs/usage.md Outdated
Comment thread docs/api.md
Remove direct vite devDependency (only needed transitively via
VitePress). Add radix parameter to parseInt in docs example.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Comment thread .github/workflows/checks.yml
@0x80
0x80 merged commit 3ce7630 into main Mar 19, 2026
5 checks passed
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