docs: improve readability, consistency, and formatting #334
Conversation
This file contains 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
sergeypanin1994
commented
Feb 18, 2025
sergeypanin1994
commented
- Fixed typos and improved clarity across multiple documentation files
- Standardized formatting for better readability
- Updated outdated links and descriptions
- Improved UI components and deployment guides for Celo Composer
- Enhanced step descriptions for a smoother setup and deployment experience
- Updated Twitter URL to x.com to reflect rebranding
- Standardized contact links formatting and improved wording for better guidance
Updated the Twitter URL from https://twitter.com to https://x.com to reflect the platform's rebranding.
- Renamed "Check Docs" to "Documentation" for clarity - Improved wording for better readability and user guidance - Ensured consistent punctuation across descriptions
- Fixed typos and improved readability - Standardized formatting for better clarity - Enhanced step descriptions for a smoother deployment experience
- Fixed typos and improved readability - Standardized formatting for clarity - Enhanced step descriptions for a smoother setup experience docs: improved deployment guide for Celo Composer - Fixed typos and improved readability - Standardized formatting for better clarity - Enhanced step descriptions for a smoother deployment experience
- Fixed typos and improved consistency - Standardized formatting for better readability - Updated outdated links and enhanced descriptions
👷 Deploy request for celo-composer pending review.Visit the deploys page to approve it
|
GigaHierz
reviewed
Feb 18, 2025
|
|
||
| - Step 4: Choose to Use a Template: You will be asked if you want to use a template. Select `Yes` or `No`. | ||
| ## **Built With** | ||
| Celo Composer is built on the Celo ecosystem and supports multiple frameworks and libraries: |
There was a problem hiding this comment.
"Celo Composer is built on Celo and supports multiple frameworks and libraries:"
GigaHierz
reviewed
Feb 18, 2025
| 3. **Select a template** (Minipay, Valora, etc.) | ||
| 4. **Provide project owner details** | ||
| 5. **Wait for project creation to complete** | ||
| 6. **Follow the on-screen instructions to start your project** | ||
|
|
There was a problem hiding this comment.
Keep the original instructions.
GigaHierz
reviewed
Feb 18, 2025
| 1. Change `packages/hardhat/env.template` to `packages/hardhat/env` and add your `PRIVATE_KEY` into the `.env` file. | ||
| 2. Make sure your wallet is funded when deploying to testnet or mainnet. You can get test tokens for deploying it on Alfajores from the [Celo Faucet](https://faucet.celo.org/alfajores). | ||
| 3. Run the following commands from the `packages/hardhat` folder to deploy your smart contract to the Celo Testnet Alfajores: | ||
| Quick steps: |
There was a problem hiding this comment.
Let's call this "Quickstart"
GigaHierz
reviewed
Feb 18, 2025
| 3. Run the following commands from the `packages/hardhat` folder to deploy your smart contract to the Celo Testnet Alfajores: | ||
| Quick steps: | ||
| 1. Rename `packages/hardhat/.env.template` to `packages/hardhat/.env` and add your `PRIVATE_KEY`. | ||
| 2. Ensure your wallet has test funds from the [Celo Faucet](https://faucet.celo.org/alfajores). |
There was a problem hiding this comment.
This sentence might not be clear to someone who is just starting in Web3
- Ensure your wallet is funded before deploying a contract. You can get test tokens from the Celo Faucet.
GigaHierz
reviewed
Feb 18, 2025
|
|
||
| 2. Open the newly renamed .env file and add your WalletConnect Cloud Project ID from [WalletConnect Cloud](https://cloud.walletconnect.com/) | ||
| ## **Deploy Your Dapp Locally** |
There was a problem hiding this comment.
Add
Find the detailed instructions on how to run your frontend in the [`react-dapp` README.md](./packages/react-app/README.md).
### Quickstart
|
|
||
| Once you've done that, you're all set to start your project! | ||
| 1. Rename `.env.template` to `.env` in `packages/react-app/`. | ||
| 2. Add your WalletConnect Project ID from [WalletConnect Cloud](https://cloud.walletconnect.com/). |
There was a problem hiding this comment.
- Add your WalletConnect Project ID from WalletConnect Cloud in the .env file.
| ## **Supported Templates** | ||
| ### **Minipay** | ||
| - Pre-configured for building a mini-payment dApp on Celo | ||
| 📖 [Minipay Docs](https://docs.celo.org/developer/build-on-minipay/overview) |
| ## **Support** | ||
| Join the Celo community on Discord: | ||
| 📌 [Celo Discord](https://chat.celo.org) | ||
| 💬 [Repo Support Channel](https://discord.com/channels/600834479145353243/941003424298856448) |
There was a problem hiding this comment.
While we are at it, the link to the dedicated repo should be removed
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.