Skip to content
This repository was archived by the owner on Mar 24, 2025. It is now read-only.

deprecate react and wallet packages #555

Open
wants to merge 3 commits into
base: beta
Choose a base branch
from
Open

Conversation

rubenmarcus
Copy link
Member

@rubenmarcus rubenmarcus commented Mar 21, 2025

PR Type

documentation, enhancement


Description

  • Deprecated the @mintbase-js/react and @mintbase-js/wallet packages in the documentation.
  • Removed related badges and download statistics from the README.
  • Added alternative package suggestions linking to @bitte-ai/react and @bitte-ai/wallet.
  • Updated package dependencies in package.json to reflect these changes.

Changes walkthrough 📝

Relevant files
Documentation
README.md
Deprecate `@mintbase-js/react` and `@mintbase-js/wallet` in README

README.md

  • Removed badges and download statistics for @mintbase-js/react and
    @mintbase-js/wallet.
  • Added deprecation notices for @mintbase-js/react and
    @mintbase-js/wallet.
  • Provided alternative package links to @bitte-ai/react and
    @bitte-ai/wallet.
  • +6/-9     
    Enhancement
    package.json
    Update package dependencies for deprecated packages           

    package.json

  • Updated dependencies to reflect the deprecation of @mintbase-js/react
    and @mintbase-js/wallet.
  • +0/-2     

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    @mintbase-codium-pr-agent
    Copy link

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review

    @mintbase-codium-pr-agent
    Copy link

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    Improve the user experience by linking directly to the specific documentation pages

    Consider updating the hyperlink for the new wallet and react packages to point
    directly to the relevant documentation or repository pages, instead of the general
    GitHub page. This would provide users with immediate access to the most relevant and
    detailed information.

    README.md [67-70]

    -- please check [@bitte-ai/wallet](https://github.com/BitteProtocol/wallet)
    -- please check [@bitte-ai/react](https://github.com/BitteProtocol/react)
    +- please check [@bitte-ai/wallet](https://github.com/BitteProtocol/wallet#readme)
    +- please check [@bitte-ai/react](https://github.com/BitteProtocol/react#readme)
     
    Suggestion importance[1-10]: 8

    Why: This suggestion enhances user experience by providing direct links to the documentation pages, making it easier for users to find relevant information quickly.

    8
    Add deprecation badges for immediate visibility in the badges section

    Since the badges for download and minification size for @mintbase-js/react and
    @mintbase-js/wallet are being removed due to deprecation, consider adding a note or
    a badge indicating the deprecation status directly in the badges section. This
    informs users immediately about the status without needing to search through the
    document.

    README.md [30-31]

     <img src='https://img.shields.io/npm/dw/@mintbase-js/data' />
     <img src='https://img.shields.io/bundlephobia/min/@mintbase-js/data' />
    +<img src='https://img.shields.io/badge/@mintbase--js/react-deprecated-red' />
    +<img src='https://img.shields.io/badge/@mintbase--js/wallet-deprecated-red' />
     
    Suggestion importance[1-10]: 6

    Why: Including deprecation badges provides immediate visibility of the status of the modules, which can be helpful for users scanning the document quickly.

    6
    Maintainability
    Add descriptions to deprecated modules for better clarity

    To maintain consistency in the README file, consider adding a brief description for
    the deprecated modules similar to other module descriptions. This helps users
    understand at a glance what these modules were used for.

    README.md [66-69]

     ### [@mintbase-js/wallet] *deprecated*
    +  - previously used for integrating wallet functionality with Mintbase
     ### [@mintbase-js/react] *deprecated*
    +  - previously used for React components and hooks specific to Mintbase
     
    Suggestion importance[1-10]: 7

    Why: Adding descriptions for deprecated modules improves clarity and helps users understand the purpose of these modules, even if they are no longer in use.

    7

    Copy link
    Contributor

    @bh2smith bh2smith left a comment

    Choose a reason for hiding this comment

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

    Did you delete these directories?

    I think it would be more appropriate to make the repo a public archive...

    Copy link
    Member

    @sainthiago sainthiago left a comment

    Choose a reason for hiding this comment

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

    agree with @bh2smith

    # for free to subscribe to this conversation on GitHub. Already have an account? #.
    Labels
    documentation Improvements or additions to documentation enhancement New feature or request Review effort [1-5]: 2
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants