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

Improved Readability and Minor Fixes in Documentation #32

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mdqst
Copy link

@mdqst mdqst commented Dec 18, 2024

During my review of the documentation, I identified a few areas where the phrasing could be improved for better readability and consistency. Here are the adjustments I made:

  1. "There can be multiple pools of the same collection, and you may create as many pools as you want."

    • Improved number agreement:
      "There can be multiple pools for the same collection, and you can create as many pools as you want."
  2. "When creating a pool, you’ll be presented with some options:"

    • Reworded for clearer expression:
      "When creating a pool, you will be presented with the following options:"
  3. "A pool with NFTs (for selling NFTs)"

    • Removed redundancy for clarity:
      "A pool with NFTs (for selling)"
  4. "You may then select the NFT collection you would like to pair with the STARS token."

    • Reworded for smoother flow:
      "You can then select the NFT collection to pair with the STARS token."
  5. "The last step is setting the pool parameters:"

    • Slightly rephrased for a more natural tone:
      "The final step is to set the pool parameters:"
  6. "The swap fee, which is the amount of tokens you will earn on every transaction (only applicable for “buy and sell” pools)."

    • Changed "amount of tokens" to "amount of STARS" for accuracy:
      "The swap fee, which is the amount of STARS you will earn on every transaction (only applicable for 'buy and sell' pools)."
  7. "The bonding curve (linear / exponential / XYK)."

    • Replaced commas with "or" to improve readability:
      "The bonding curve (linear, exponential, or XYK)."

These changes aim to enhance the clarity and precision of the documentation ;)

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

Successfully merging this pull request may close these issues.

1 participant