Skip to content

docs: add not maintained notices to docs site - #176

Merged
amilz merged 2 commits into
mainfrom
docs/DEV-14-docs-site-deprecation
Oct 23, 2026
Merged

amilz merged 2 commits into
mainfrom
docs/DEV-14-docs-site-deprecation

Conversation

@amilz

@amilz amilz commented Oct 23, 2026

Copy link
Copy Markdown
Contributor
  • Add a site-wide banner (landing + docs) saying Framework Kit is no longer maintained, linking Solana Kit and Kit plugins
  • Add a warning callout to each docs page, pointing to the replacement for that package (Kit plugins, @solana/react, web3.js v3), matching the README notices from docs: deprecate web3-compat and point to replacements #174
  • Replace the landing page "V1 is now available" pill with a deprecation link to solanakit.com

@linear

linear Bot commented Oct 23, 2026

Copy link
Copy Markdown

DEV-14

@vercel

vercel Bot commented Oct 23, 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 23, 2026 4:57pm UTC

Request Review

@amilz amilz changed the title docs: add deprecation notices to docs site docs: add not maintained notices to docs site Oct 23, 2026
@greptile-apps

greptile-apps Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The PR appears safe to merge, with no outstanding findings.

Summary

Adds maintenance warnings across the docs site.

  • The landing page and site banner point visitors to Solana Kit and Kit plugins.
  • Each package page points readers to its named replacement.
  • The docs overview and setup page guide new projects to current Solana tools.

Reviews (2) · Last reviewed commit: "docs: list web3.js v3 as released on doc..." · Reviewed by Greptile

---

<Callout type="warn" title="No longer maintained">
`@solana/web3-compat` is no longer maintained. Use [web3.js v3](https://github.com/solana-foundation/solana-web3.js) instead: it wraps Kit while keeping the web3.js interfaces. See the [web3.js v1 to v3 migration guide](https://github.com/solana-foundation/solana-web3.js/blob/main/docs/web3js-v1-to-v3-migration.md).

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 Migration advice disagrees

This notice tells readers to use web3.js v3 immediately, but index.mdx says it is not released yet. Readers get different advice about whether they can migrate today. Add the same release caveat here so readers arriving directly on this page see it too.

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.

web3.js v3 is released, so I removed the "not released yet" caveat from index.mdx instead of adding it here (b04ce6a). The docs index now matches the root README.

@amilz
amilz merged commit 158aeb0 into main Oct 23, 2026
13 checks passed
@amilz
amilz deleted the docs/DEV-14-docs-site-deprecation branch October 23, 2026 17:20

This branch was successfully deployed

1 active deployment
Preview — b04ce6a0 Deployed Oct 23, 2026 by vercel[bot]
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