celo-org / celo-composer

celo-composer is a starter project with all code needed to build, deploy, and upgrade a dapps on Celo.
MIT License
117 stars 110 forks source link

Docs added for celo-composer #148

Closed viral-sangani closed 1 year ago

viral-sangani commented 1 year ago

Created Sample docs for Celo Composer. Added a few basic pages like Introduction, getting started pages, etc. We need to add framework/tools-specific pages.

Let's all work in this branch docs and build it together. cc. @Ernesto-tha-great @joenyzio @alofeoluwafemi @therealharpaljadeja @nestorbonilla

netlify[bot] commented 1 year ago

Deploy Preview for celo-composer failed.

Name Link
Latest commit 1ab61546f1b05e2df37c20b28de8a3dfb445cb88
Latest deploy log https://app.netlify.com/sites/celo-composer/deploys/637250637b14b0000aaf94ea
viral-sangani commented 1 year ago

Let's share the framework and tools section for docs. We can take the framework we have worked on or are most familiar with and write that section of the docs.

socket-security[bot] commented 1 year ago

Socket Security Pull Request Report

Dependency issues detected. If you merge this pull request, you will not be alerted to the instances of these issues again.

😵‍💫 Bin script confusion

This package has multiple bin scripts with the same name. This can cause non-deterministic behavior when installing or could be a sign of a supply chain attack

Consider removing one of the conflicting packages. Packages should only export bin scripts with their name

Package Bin script Location
detect-port@1.5.1 (added) detect-port docs/package.json via @docusaurus/core@2.2.0,packages/hardhat/package.json via solidity-coverage@0.7.22
detect-port-alt@1.1.6 (added) detect-port docs/package.json via @docusaurus/core@2.2.0, react-dev-utils@12.0.1
detect-port@1.5.1 (added) detect docs/package.json via @docusaurus/core@2.2.0,packages/hardhat/package.json via solidity-coverage@0.7.22
detect-port-alt@1.1.6 (added) detect docs/package.json via @docusaurus/core@2.2.0, react-dev-utils@12.0.1
Pull request report summary
Issue Status
Install scripts ✅ 0 issues
Native code ✅ 0 issues
Bin script confusion ⚠️ 4 issues
Bin script shell injection ✅ 0 issues
Unresolved require ✅ 0 issues
Invalid package.json ✅ 0 issues
HTTP dependency ✅ 0 issues
Git dependency ✅ 0 issues
Non-existent author ✅ 0 issues
Potential typo squat ✅ 0 issues
Known Malware ✅ 0 issues
Telemetry ✅ 0 issues
Protestware/Troll package ✅ 0 issues
Bot Commands

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of package-name@version specifiers. e.g. @SocketSecurity ignore foo@1.0.0 bar@2.4.2

  • @SocketSecurity ignore detect-port@1.5.1
  • @SocketSecurity ignore detect-port-alt@1.1.6

Powered by socket.dev

alofeoluwafemi commented 1 year ago

@therealharpaljadeja, do you want us to start the contribution after PR is merged or proceed regardless? What's your plan?

viral-sangani commented 1 year ago

@alofeoluwafemi I was hoping we could deploy the docs once we fill all the framework pages. Because merging empty pages doesn't seem reasonable.

nestorbonilla commented 1 year ago

Closing PR for outdated. If it needs to be re-opened, please feel free to do it.