Skip to content

docs: Add maintenance warning and alternatives to README - #173

Merged
gitteri merged 3 commits into
mainfrom
ilangitter/eco-706-add-maintenance-warning-and-alternatives-to-framework-kit
Oct 1, 2026
Merged

gitteri merged 3 commits into
mainfrom
ilangitter/eco-706-add-maintenance-warning-and-alternatives-to-framework-kit

Conversation

@gitteri

@gitteri gitteri commented Oct 1, 2026 •

Copy link
Copy Markdown
Contributor

Framework-kit isn't maintained anymore, so this puts a warning at the top of the main README pointing people at Kit plugins (closest replacement), Solana Kit, and the upcoming web3.js v3 wrapper around Kit.

Also fixes the Dependency Audit check, which was failing on main too since advisories piled up after the last release. Next goes to 16.3.8 in the docs app and the nextjs example, and the rest are pnpm overrides kept within each package's current major. stream-json is the one exception: jayson 4 (via @solana/web3.js) needs 1.x and the fix is in 3.x, so that GHSA is ignored in auditConfig since jayson doesn't touch the affected filters.

No published package changes, so no changeset.

Closes ECO-706

@gitteri gitteri added the skip-changeset Skip changeset requirement for docs-only PRs label Oct 1, 2026
@vercel

vercel Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
framework-kit-docs Ready Ready Preview Oct 1, 2026 6:05pm UTC

Request Review

@linear

linear Bot commented Oct 1, 2026

Copy link
Copy Markdown

ECO-706

@gitteri
gitteri marked this pull request as ready for review October 1, 2026 15:11
@greptile-apps

greptile-apps Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

RetriggerConfidence Score: 4/5

[High risk] Updates Next.js versions and adds security vulnerability overrides.

The PR is not ready to merge without satisfying the required changeset check.

Findings

  1. P1 Dependency changes fail changeset check ▶
  2. P2 Upcoming option listed for immediate use ▶

Summary

The PR adds a maintenance warning and alternatives to the README. Since the previous review, it also updates Next.js, adds workspace dependency overrides and an audit exception, and refreshes the lockfile.

  • The warning now separates unreleased web3.js v3 from alternatives available for new projects.
  • The dependency changes make the PR subject to the required changeset check.

Reviews (3) · Last reviewed commit: "fix: bump next and override vulnerable t..."

Comment thread README.md Outdated
>
> - [Kit plugins](https://github.com/anza-xyz/kit-plugins): composable client plugins for Kit, and the closest replacement for Framework-kit.
> - [Solana Kit](https://github.com/anza-xyz/kit): the Solana JavaScript SDK.
> - [web3.js v3](https://github.com/solana-foundation/solana-web3.js): an upcoming wrapper around Kit that keeps the web3.js interfaces.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Upcoming option listed for immediate use
The warning tells new projects to “use one of these instead,” but describes web3.js v3 as “upcoming.” That makes this recommendation less useful to readers looking for an alternative they can use now. Please distinguish it from the currently usable options.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Moved web3.js v3 out of the use-now list and marked it as not released yet in f9e6293.

amilz
amilz previously approved these changes Oct 1, 2026
…passes

Next goes to 16.3.8 in docs and the nextjs example. The rest are pnpm overrides pinned within each package's current major. stream-json can't move past 1.x without breaking jayson 4 (pulled in by @solana/web3.js), so its filter DoS advisory is ignored in auditConfig since jayson doesn't use those filters.
Comment thread package.json
"packageManager": "pnpm@10.20.0",
"pnpm": {
"overrides": {
"@babel/core@<7.29.6": "^7.29.6",

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Dependency changes fail changeset check
This PR now changes workspace dependencies as well as the README. If the PR has no skip-changeset label, CI treats these as non-documentation changes and fails its required changeset check because no changeset was added. Add the approved label or a changeset.

Knowledge Base Used: Build and release tooling

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

skip-changeset label is on this PR and Require Changeset passes. The changes are root overrides plus the private docs app and nextjs example, nothing published.

@gitteri
gitteri merged commit ec2a3e8 into main Oct 1, 2026
13 checks passed

This branch was successfully deployed

1 active deployment
Preview — 1dc60d88 Deployed Oct 1, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-changeset Skip changeset requirement for docs-only PRs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants