core icon indicating copy to clipboard operation
core copied to clipboard

Docs/improve package readmes

Open lukasbauer54 opened this issue 9 months ago • 3 comments

Explanation

This PR improves the README files for the following 15 packages by adding clear descriptions of their purposes and usage examples:

base-controller controller-utils bridge-status-controller bridge-controller assets-controllers user-operation-controller transaction-controller keyring-controller network-controller signature-controller gas-fee-controller permission-controller notification-services-controller multichain-network-controller preferences-controller

References

addressing issue #5742

Checklist

  • [ ] I've updated the test suite for new or updated code as appropriate
  • [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • [ ] I've communicated my changes to consumers by updating changelogs for packages I've changed, highlighting breaking changes as necessary
  • [ ] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

lukasbauer54 avatar May 21 '25 09:05 lukasbauer54

Hi @mcmire , Could you please review the changes and let me know if I’m heading in the right direction? If everything looks good, I’d appreciate it if you could go ahead and merge this. I’ll send a separate PR for the remaining packages shortly. If there’s anything that needs to be changed or improved, please let me know. Thanks!

lukasbauer54 avatar May 21 '25 09:05 lukasbauer54

Thank you @lukasbauer54, I will try to review this when I get a chance.

mcmire avatar May 21 '25 17:05 mcmire

@mcmire Sure. Let me know if I need to fix anything.

lukasbauer54 avatar Jun 15 '25 16:06 lukasbauer54