Skip to content

chore: remove VitePress#3873

Merged
mrlubos merged 1 commit into
mainfrom
docs/remove-vitepress
May 14, 2026
Merged

chore: remove VitePress#3873
mrlubos merged 1 commit into
mainfrom
docs/remove-vitepress

Conversation

@mrlubos
Copy link
Copy Markdown
Member

@mrlubos mrlubos commented May 14, 2026

No description provided.

@bolt-new-by-stackblitz
Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 14, 2026

⚠️ No Changeset found

Latest commit: 3e25e73

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

@vercel
Copy link
Copy Markdown

vercel Bot commented May 14, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
web Ready Ready Preview, Comment May 14, 2026 3:20am

Request Review

@mrlubos mrlubos marked this pull request as ready for review May 14, 2026 03:19
@dosubot dosubot Bot added size:XXL This PR changes 1000+ lines, ignoring generated files. internal ⚙️ Internal development work. labels May 14, 2026
Copy link
Copy Markdown
Contributor

@pullfrog pullfrog Bot left a comment

Choose a reason for hiding this comment

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

TL;DR — Removes the VitePress documentation site now that the docs have moved into the Astro web/ workspace. Mechanical deletion across configs, ignore files, workspace, and the patches/vitepress.patch pin, plus a few small follow-ups (coverage.yml path-ignore swap, web package description, User-Agent rename).

Key changes

  • Drop the docs/ VitePress site — removes the entire docs/ workspace, the vitepress patched dependency, and matching ignore globs in .oxfmtrc.json, .prettierignore, .vscode/settings.json, eslint.config.js, turbo.json, and .vercelignore.
  • Swap CI path-ignore from docs/** to web/**coverage.yml now skips when only the Astro site changes, mirroring the new location of documentation.
  • Rename web artifactsweb/package.json description becomes "Hey API website" and fetchSponsorGoal uses User-Agent: hey-api-web.
  • Soft-disable SINCE_FILE in update-contributors.sh — comments out the assignment and the write since the backing docs/.contributorssince is gone (the surrounding block was already disabled).

Summary | 135 files | 1 commit | base: maindocs/remove-vitepress


Stale docs references in agent docs

Before: Agent docs explicitly listed docs/ as the VitePress site and referred to it in build timing/workarounds.
After: This PR removes some of those references but a few stragglers still point at a docs build that no longer exists.

Specifically, after this PR these lines still mention docs as a build target/artifact:

None of these block anything at runtime, but they will mislead future agents reading the guidance. Worth a one-line cleanup in this PR since the rest of those files were already touched.

CLAUDE.md · .github/copilot-instructions.md


Dead SINCE_FILE reference in update-contributors.sh

Before: SINCE_FILE="./docs/.contributorssince" was a live assignment but the surrounding read/write block was already commented out.
After: Both the assignment and the trailing echo > "$SINCE_FILE" are commented out, leaving a dangling reference to a deleted file.

Since the variable has no remaining live references in the script, the comments are doc-pointing-at-nothing. Cleaner to delete the two lines outright (or the entire dead block) rather than leave commented references to a path that no longer exists.

scripts/update-contributors.sh


Sanity checks

Before: N/A — verification notes for the reviewer.
After: Cross-checks I ran on the diff.

  • pnpm-workspace.yaml and patchedDependencies removal of vitepress line up — no other consumer of the patch.
  • vercel.json redirect chain (/openapi-ts/* → /docs/openapi/typescript/*) still resolves into the Astro site under web/src/content/docs/docs/openapi/typescript/*.mdx.
  • coverage.yml paths-ignore swap from docs/** to web/** matches the new docs location.
  • Public-facing heyapi.dev/openapi-ts/* links in package READMEs and changelogs are unchanged — those are URLs, not workspace paths, so they remain valid via the redirects.

Draft status looks right while you double-check link health against the Astro site post-merge.

Pullfrog  | Fix all ➔Fix 👍s ➔View workflow run | Using Claude Opus𝕏

fi

SINCE_FILE="./docs/.contributorssince"
# SINCE_FILE="./docs/.contributorssince"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nit: SINCE_FILE no longer has any live references (the read on lines 22-26 and the write on line 108 are both commented out) and the backing file is deleted in this PR. Cleaner to drop this line and the rest of the dead block entirely rather than leave a comment pointing at docs/.contributorssince, which no longer exists.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 14, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 39.58%. Comparing base (2322860) to head (3e25e73).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3873   +/-   ##
=======================================
  Coverage   39.58%   39.58%           
=======================================
  Files         532      532           
  Lines       19581    19581           
  Branches     5835     5829    -6     
=======================================
  Hits         7751     7751           
  Misses       9582     9582           
  Partials     2248     2248           
Flag Coverage Δ
unittests 39.58% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 14, 2026

Open in StackBlitz

@hey-api/codegen-core

npm i https://pkg.pr.new/@hey-api/codegen-core@3873

@hey-api/json-schema-ref-parser

npm i https://pkg.pr.new/@hey-api/json-schema-ref-parser@3873

@hey-api/nuxt

npm i https://pkg.pr.new/@hey-api/nuxt@3873

@hey-api/openapi-ts

npm i https://pkg.pr.new/@hey-api/openapi-ts@3873

@hey-api/shared

npm i https://pkg.pr.new/@hey-api/shared@3873

@hey-api/spec-types

npm i https://pkg.pr.new/@hey-api/spec-types@3873

@hey-api/types

npm i https://pkg.pr.new/@hey-api/types@3873

@hey-api/vite-plugin

npm i https://pkg.pr.new/@hey-api/vite-plugin@3873

commit: 3e25e73

@mrlubos mrlubos merged commit 109ed12 into main May 14, 2026
12 checks passed
@mrlubos mrlubos deleted the docs/remove-vitepress branch May 14, 2026 03:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal ⚙️ Internal development work. size:XXL This PR changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant