Docs/improve package readmes #5840
Open
+2,206
−104
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ler, and controller-utils - Expanded documentation for `@metamask/base-controller` to include detailed features, usage examples, and API reference. - Updated `@metamask/bridge-status-controller` README with comprehensive features, usage instructions, and state management details. - Improved `@metamask/controller-utils` documentation by adding examples for hex utilities, safe execution, network operations, and data validation functions.
… and user-operation-controller - Expanded documentation for `@metamask/assets-controllers` to include detailed features, usage examples, and API reference for managing ERC-20, ERC-721, and ERC-1155 tokens, as well as DeFi positions and currency rates. - Updated `@metamask/bridge-controller` README with comprehensive features, usage instructions, and state management details for cross-chain token swaps. - Improved `@metamask/user-operation-controller` documentation by detailing user operation management, transaction conversion, and bundler integration.
…, and transaction-controller - Expanded documentation for `@metamask/keyring-controller` to include detailed features, usage examples, and state management for cryptographic identities and keyring operations. - Updated `@metamask/network-controller` README with comprehensive features, usage instructions, and state management details for network configurations and interactions. - Improved `@metamask/transaction-controller` documentation by detailing transaction lifecycle management, gas fee handling, and error handling strategies.
…ler, and signature-controller - Expanded documentation for `@metamask/gas-fee-controller` to include detailed features, usage examples, and state management for gas fee estimations, supporting both legacy and EIP-1559 pricing. - Updated `@metamask/permission-controller` README with comprehensive features, usage instructions, and state management details for managing permissions and caveats. - Improved `@metamask/signature-controller` documentation by detailing signature request management, types of signatures supported, and error handling strategies.
…ation-services-controller, and preferences-controller - Expanded documentation for `@metamask/multichain-network-controller` to include detailed features, usage examples, and state management for multi-chain network configurations, supporting both EVM and non-EVM networks. - Updated `@metamask/notification-services-controller` README with comprehensive features, usage instructions, and state management details for managing various notification types and push services across platforms. - Improved `@metamask/preferences-controller` documentation by detailing user-configurable settings, feature flag management, and error handling strategies for user preferences in MetaMask.
|
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. |
|
Thank you @lukasbauer54, I will try to review this when I get a chance. |
|
@mcmire Sure. Let me know if I need to fix anything. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explanation
This PR improves the README files for the following 15 packages by adding clear descriptions of their purposes and usage examples:
base-controllercontroller-utilsbridge-status-controllerbridge-controllerassets-controllersuser-operation-controllertransaction-controllerkeyring-controllernetwork-controllersignature-controllergas-fee-controllerpermission-controllernotification-services-controllermultichain-network-controllerpreferences-controllerReferences
addressing issue #5742
Checklist