chore: remove VitePress#3873
Conversation
|
|
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
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 entiredocs/workspace, thevitepresspatched 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/**toweb/**—coverage.ymlnow skips when only the Astro site changes, mirroring the new location of documentation. - Rename
webartifacts —web/package.jsondescription becomes "Hey API website" andfetchSponsorGoalusesUser-Agent: hey-api-web. - Soft-disable
SINCE_FILEinupdate-contributors.sh— comments out the assignment and the write since the backingdocs/.contributorssinceis gone (the surrounding block was already disabled).
Summary | 135 files | 1 commit | base: main ← docs/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:
CLAUDE.md:10—pnpm build # Build everything (packages + examples + docs).github/copilot-instructions.md:25—Build all including examples (NEVER CANCEL - takes ~5+ minutes ...)comment still references a docs build.github/copilot-instructions.md:63—pnpm build: ~5+ minutes (includes docs and examples).github/copilot-instructions.md:72—Use pnpm build --filter="@hey-api/**" to build packages without docs
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 trailingecho > "$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.yamlandpatchedDependenciesremoval ofvitepressline up — no other consumer of the patch.vercel.jsonredirect chain (/openapi-ts/* → /docs/openapi/typescript/*) still resolves into the Astro site underweb/src/content/docs/docs/openapi/typescript/*.mdx.coverage.ymlpaths-ignore swap fromdocs/**toweb/**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.
Claude Opus | 𝕏
| fi | ||
|
|
||
| SINCE_FILE="./docs/.contributorssince" | ||
| # SINCE_FILE="./docs/.contributorssince" |
There was a problem hiding this comment.
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 Report✅ All modified and coverable lines are covered by tests. 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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
@hey-api/codegen-core
@hey-api/json-schema-ref-parser
@hey-api/nuxt
@hey-api/openapi-ts
@hey-api/shared
@hey-api/spec-types
@hey-api/types
@hey-api/vite-plugin
commit: |

No description provided.