From 415728002f4ab21376d4c603ab34f9c806dbc5fb Mon Sep 17 00:00:00 2001 From: dappsar Date: Thu, 26 Dec 2024 22:44:43 -0300 Subject: [PATCH] [docs] :memo: refactor general documentation --- .doc/content.md | 9 +++++++++ ...-guidelines.md => deployment-guidelines.md} | 2 +- README.md | 18 +++++++++--------- 3 files changed, 19 insertions(+), 10 deletions(-) create mode 100644 .doc/content.md rename .doc/deployment/{deploy-guidelines.md => deployment-guidelines.md} (95%) diff --git a/.doc/content.md b/.doc/content.md new file mode 100644 index 0000000..132e936 --- /dev/null +++ b/.doc/content.md @@ -0,0 +1,9 @@ +# Content + +## Development + +- [Coding Guidelines](./development/coding-guidelines.md) + +## Deployment + +- [Deployment Guidelines](./deployment/deployment-guidelines.md) diff --git a/.doc/deployment/deploy-guidelines.md b/.doc/deployment/deployment-guidelines.md similarity index 95% rename from .doc/deployment/deploy-guidelines.md rename to .doc/deployment/deployment-guidelines.md index 61eeb0b..ca31187 100644 --- a/.doc/deployment/deploy-guidelines.md +++ b/.doc/deployment/deployment-guidelines.md @@ -1,4 +1,4 @@ -# Deploy Guidelines +# Deployment Guidelines ## Upload Frontend to ICP diff --git a/README.md b/README.md index c363c39..2d9a65a 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ # ChatterPay -Chatterpay is a Wallet for WhatsApp that integrates AI and Account Abstraction, enabling any user to use blockchain easily and securely without technical knowledge. +[Chatterpay](chatterpay.net) is a Wallet for WhatsApp that integrates AI and Account Abstraction, enabling any user to use blockchain easily and securely without technical knowledge. > Built for: [Level Up Hackathon - Ethereum Argentina 2024](https://ethereumargentina.org/) @@ -102,9 +102,13 @@ To deploy the landing (static code) to the [Internet Computer (ICP)](https://int URL of the deployed app on ICP: https://cilxj-yiaaa-aaaag-alkxq-cai.icp0.io/ - # Additional Info +## Technical Documentation + +If you would like to explore more details about the source code, you can review this [link](.doc/content.md). + + ## Contribution Thank you for considering helping out with the source code! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes! @@ -113,13 +117,9 @@ If you'd like to contribute to ChatterPay, please fork, fix, commit and send a p Please make sure your contributions adhere to our [coding guidelines](./.doc/development/coding-guidelines.md). -## Contributors - -[P4Troy](https://github.com/mpefaur) - [dappsar](https://github.com/dappsar) - [tomasDmArg](https://github.com/TomasDmArg) - -see more in: +_Contributors_: +* [P4Troy](https://github.com/mpefaur) - [dappsar](https://github.com/dappsar) - [tomasDmArg](https://github.com/TomasDmArg) -## Maintenance +* See more in: -- [Maintenance Scripts](./.doc/maintenance/maintenance-scripts.md)