celo-composer icon indicating copy to clipboard operation
celo-composer copied to clipboard

Sync composer docs from Gitbook to Github

Open alofeoluwafemi opened this issue 2 years ago • 4 comments

Docs is hosted on https://celo-composer.gitbook.io/docs/. @therealharpaljadeja @joenyzio

alofeoluwafemi avatar Oct 27 '22 17:10 alofeoluwafemi

Deploy Preview for celo-composer failed.

Name Link
Latest commit 6d45186f6e6b897fda6375a1e44fbbbde0032545
Latest deploy log https://app.netlify.com/sites/celo-composer/deploys/635ac39a8ff4450009262a94

netlify[bot] avatar Oct 27 '22 17:10 netlify[bot]

@alofeoluwafemi It seems the docs are quite outdated. Need to update the docs before we can merge it. Some suggestions on top of my mind -

  • In the installation section, instead is cloning the repo, need to add CLI.
  • In the supported framework need to add Angular and truffle
  • Need to remove the empty pages or at least add some content.
  • Can create a section like a showcase - Projects built with Celo Composer. (We are working on a list of Celo composer examples - https://github.com/organizations/celo-example)
  • Add React Advance and React Black boilerplate in the docs.

There are some other features that we can add in docs. Happy to help and share the workload. Let me know if you need any more information or want to schedule a call for this.

viral-sangani avatar Nov 02 '22 14:11 viral-sangani

@viral-sangani, yes I agree we should have a session to plan this out better. I was of the opinion of merging first before I improve the installation process. I will do a follow-up chat on discord

alofeoluwafemi avatar Nov 02 '22 17:11 alofeoluwafemi

@alofeoluwafemi Had a chat with Eric about this; since we are going to add a lot of new docs for the composer, can we go with Docusaurus instead of Gitbook since we are already using Docusaurus for Celo docs.

viral-sangani avatar Nov 03 '22 17:11 viral-sangani

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

nestorbonilla avatar Mar 12 '23 08:03 nestorbonilla