Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

General and Specific Suggestions for better readability of Docs. #1704

Open
TheSpectre910 opened this issue Oct 11, 2024 · 1 comment
Open

Comments

@TheSpectre910
Copy link

TheSpectre910 commented Oct 11, 2024

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:

  1. "WalletConnect API's" should be "WalletConnect APIs" (remove the apostrophe).
  2. "It's public API" should be "Its public API" (use "its" for possession).
  3. In various places, "you can simply import it from their CDN" could be clearer as "you can import it from the CDN" for conciseness.
  4. "Add packages (NPM)" and similar headers could be more uniform. For example, consider using "Add Packages (NPM)" for consistency in capitalization.

Specific Suggestions:

  1. Installation Section:
    "Add packages (NPM)": The command should be formatted correctly. Change (bash npm2yarn) to (bash) (remove "npm2yarn").

  2. 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.

  3. 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.

  4. 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").

  5. 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.

Copy link

linear bot commented Oct 11, 2024

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

No branches or pull requests

2 participants
@TheSpectre910 and others