Skip to content

chore: clean up plans, fix license, update READMEs#8

Merged
Quantumlyy merged 4 commits intomainfrom
Quantumlyy/gh-repo-metadata
Apr 4, 2026
Merged

chore: clean up plans, fix license, update READMEs#8
Quantumlyy merged 4 commits intomainfrom
Quantumlyy/gh-repo-metadata

Conversation

@Quantumlyy
Copy link
Copy Markdown
Member

Summary

  • Delete 6 completed plan files (testing, CI, modernization, readme-examples, integration-testing, bitbit-wallet-standard) and update the plans index
  • Update plans/roadmap.md to check off ~20 implemented milestones
  • Set LICENSE copyright to 2026 Nejc Drobnič (was placeholder [yyyy] [name of copyright owner])
  • Update all package READMEs to match current codebase: rename satsConnectxverse, add walletStandard connector docs, add missing token hooks/actions/utilities, fix config API (network not networks), add @mbga/kit and @mbga/flashnet to related packages tables
  • Create new packages/kit/README.md covering styled + headless components, theming, and utilities

Remove 6 completed plan files (testing, CI, modernization, readme-examples,
integration-testing, bitbit-wallet-standard). Update roadmap to reflect
implemented milestones. Set LICENSE copyright to 2026 Nejc Drobnič. Update
all package READMEs to match current codebase: rename satsConnect to xverse,
add walletStandard connector docs, add missing token hooks/actions, fix
config API (network not networks), add @mbga/kit README.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 4, 2026

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

Project Deployment Actions Updated (UTC)
mbga-site Ready Ready Preview, Comment Apr 4, 2026 0:34am


function App() {
return (
<KitProvider config={config}>
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This quick start cannot work as written. KitProviderProps only accepts theme and customTheme, and the component docs explicitly say it must be placed inside MbgaProvider. Copy-pasting <KitProvider config={config}> will fail type-checking on config, and rendering ConnectButton without MbgaProvider will still break at runtime. The theming snippet below has the same API mismatch (theme is a preset name, not a theme object).


### `walletStandard`

Connects to any wallet that implements the [Wallet Standard](https://github.com/wallet-standard/wallet-standard) with `spark:*` features. Automatically discovers compatible wallets at runtime.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This walletStandard section is describing the discovery plugin, not the connector itself. WalletStandardParameters requires a concrete wallet, so walletStandard() with no arguments will not compile, and automatic discovery actually lives in walletStandardDiscovery(). Copy-pasting this example sends readers to a nonexistent zero-config flow.

npm install mbga @mbga/connectors sats-connect @tanstack/react-query
pnpm add mbga @mbga/connectors sats-connect @tanstack/react-query
yarn add mbga @mbga/connectors sats-connect @tanstack/react-query
npm install mbga @mbga/connectors @tanstack/react-query
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The new install command is missing a required dependency for the very next example. xverse imports sats-connect, and @mbga/connectors exposes it as a peer dependency. A fresh install following this README will fail as soon as someone imports mbga/connectors unless they also add sats-connect.

…stall

- KitProvider requires MbgaProvider parent, not a config prop — fix quick
  start to show correct nesting
- walletStandard connector requires a wallet arg; document the
  walletStandardDiscovery plugin for auto-discovery instead
- Restore sats-connect in react install command (peer dep of xverse)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Rename all GitHub URLs, repository fields, badge links, codecov slugs,
and docs site references to the new org.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- List all required packages in install command (mbga, @mbga/core,
  @mbga/connectors, sats-connect, @tanstack/react-query)
- Fix theming example: use theme="dark" string (not darkTheme object),
  show customTheme prop, remove nonexistent config prop

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@Quantumlyy Quantumlyy merged commit 102ead7 into main Apr 4, 2026
8 checks passed
@Quantumlyy Quantumlyy deleted the Quantumlyy/gh-repo-metadata branch April 4, 2026 12:37
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.

1 participant