Hi,
I have been reading the WalletConnect Docs specifying the exact Doc folder as follow: docs > advanced > walletconnectmodal > about.mdx
There are Few General and Specific Suggestions i want to Write down here, please take a look at it.
General Suggestions:
"WalletConnect API's" should be "WalletConnect APIs" (remove the apostrophe).
"It's public API" should be "Its public API" (use "its" for possession).
In various places, "you can simply import it from their CDN" could be clearer as "you can import it from the CDN" for conciseness.
"Add packages (NPM)" and similar headers could be more uniform. For example, consider using "Add Packages (NPM)" for consistency in capitalization.
Specific Suggestions:
Installation Section:
"Add packages (NPM)": The command should be formatted correctly. Change (bash npm2yarn) to (bash) (remove "npm2yarn").
Caution Notes:
Change "public API and associated documentation may still see significant and breaking changes." to "public API, and the associated documentation, may still see significant and breaking changes." for clarity.
Swift Package Manager:
In "To integrate via a Package.swift manifest instead of Xcode", consider rephrasing to "To integrate using a Package.swift manifest instead of Xcode," for clarity.
React Native Section:
"Additionally add these extra packages to help with async storage, polyfills, modals and SVG's." should be "Additionally, add these extra packages to help with async storage, polyfills, modals, and SVGs." (remove the apostrophe in "SVG's" and add a comma before "and").
Important Note Sections:
In "Important Note: The WalletConnect SDK will only be able to detect the wallets that you explicitly list in your native files.", consider changing "that" to "which" for better flow: "Important Note: The WalletConnect SDK will only be able to detect the wallets which you explicitly list in your native files."
Formatting:
Make sure code blocks and examples are consistently formatted throughout the document for a cleaner look.
Consider using bullet points for lists (e.g., in the Requirements section) to enhance readability.
linear[bot]
commented
1 week ago
Hi, I have been reading the WalletConnect Docs specifying the exact Doc folder as follow: docs > advanced > walletconnectmodal > about.mdx There are Few General and Specific Suggestions i want to Write down here, please take a look at it.
General Suggestions:
Specific Suggestions:
Installation Section: "Add packages (NPM)": The command should be formatted correctly. Change (bash npm2yarn) to (bash) (remove "npm2yarn").
Caution Notes: Change "public API and associated documentation may still see significant and breaking changes." to "public API, and the associated documentation, may still see significant and breaking changes." for clarity.
Swift Package Manager: In "To integrate via a Package.swift manifest instead of Xcode", consider rephrasing to "To integrate using a Package.swift manifest instead of Xcode," for clarity.
React Native Section: "Additionally add these extra packages to help with async storage, polyfills, modals and SVG's." should be "Additionally, add these extra packages to help with async storage, polyfills, modals, and SVGs." (remove the apostrophe in "SVG's" and add a comma before "and").
Important Note Sections: In "Important Note: The WalletConnect SDK will only be able to detect the wallets that you explicitly list in your native files.", consider changing "that" to "which" for better flow: "Important Note: The WalletConnect SDK will only be able to detect the wallets which you explicitly list in your native files."
Formatting: Make sure code blocks and examples are consistently formatted throughout the document for a cleaner look. Consider using bullet points for lists (e.g., in the Requirements section) to enhance readability.