celo-org / docs

Welcome

Welcome to the technical documentation site for the Celo project! You can check out the live site at https://docs.celo.org.

Getting Started

This documentation site is built using Docusaurus v2.

You can run the site locally by cloning this repository, installing dependencies and starting docusaurus.

git clone https://github.com/celo-org/docs.git
cd docs
yarn
yarn start

Edit files in the /docs directory to make updates to the documentation pages. Pages will be automatically updated when you are running the development server.

Files

• .gitignore - This specifies which files Git should ignore when committing and pushing to remote repositories.
• docusaurus.config.js - This is the configuration file for Docusaurus. You can manage the links in the header and footer, and site metadata here. A more in-depth introduction to this configuration file is available on the Docusaurus website and full documentation for the API is here.
• package.json - This specifies the dependencies for the website and the commands that you can run with yarn.
• sidebars.js - This specifies the sidebars for your documentation. The full documentation for this file is available on the Docusaurus website.
• yarn.lock - This specifies the full dependencies for the website including the dependencies of the dependencies listed in package.json. Do not edit this file directly. Edit package.json instead, then run yarn as described above.

The .md files in the docs directory are the docs. See the Docusaurus website for the full documentation on how to create docs and to manage the metadata.

Contributing

We welcome contributions from the community. Please review our contribution guidelines for more information.

You can find many of the other main Celo project repositories at https://github.com/celo-org.

Internationalization

We are managing translations using Crowdin. You can find the Celo Docs Crowdin project here. From here, click on the language that you would like to help translate the docs into.

Due to inconsistencies with managing the source code in 2 places (Github and Crowdin), only the English source code is stored in this repo. The translation sources are stored on Crowdin and are fetched when the site is built.

Some files are marked as high priority. In the following image you can see the up arrow on the right side of the file line, indicating the file is a higher priority than others. Please focus on files marked as high priority.

If you have any questions, please post in the project discussions tab here.

Contact

Join us on Discord or file an issue.

Code of Conduct

Please review the code of conduct before contributing.

docs's Issues

Change CLI command examples to use generic directories and users

Important Information Section Audit

Complete audit for Important Information section in docs.celo.org.

What to do
Review docs to ensure they are fresh, clear, and accessible

• Fresh: Is everything written up to date and accurate?
• Clear: Is everything clearly explained?
• Accessible: Is everything well organized and easy to find?

Key questions

• What do we have that we need?
• What do we have that we don’t need?
• What do we don’t have that we need?

Add tag when complete

• Create: Submit a request to create a new page.
• Read: Assign to a new partner for review.
• Update: Needs updates with notes on next steps.
• Delete: Delete the page.
• Complete: Everything is fresh, clear, and accessible.

No additional action is needed yet. This first pass is meant to help develop a backlog.

Owners Section Audit

Complete audit for Celo Owner section in docs.celo.org.

What to do
Review docs to ensure they are fresh, clear, and accessible

• Fresh: Is everything written up to date and accurate?
• Clear: Is everything clearly explained?
• Accessible: Is everything well organized and easy to find?

Key questions

• What do we have that we need?
• What do we have that we don’t need?
• What do we don’t have that we need?

Add tag when complete

• Create: Submit a request to create a new page.
• Read: Assign to a new partner for review.
• Update: Needs updates with notes on next steps.
• Delete: Delete the page.
• Complete: Everything is fresh, clear, and accessible.

No additional action is needed yet. This first pass is meant to help develop a backlog.

Deploy and Interact with Contracts (Remotely)

Audit https://docs.celo.org/developer-guide/start/hello-contract-remote-node

Developers Section Audit

Complete audit for Developer Guide section in docs.celo.org.

What to do
Review docs to ensure they are fresh, clear, and accessible

• Fresh: Is everything written up to date and accurate?
• Clear: Is everything clearly explained?
• Accessible: Is everything well organized and easy to find?

Key questions

• What do we have that we need?
• What do we have that we don’t need?
• What do we don’t have that we need?

Add tag when complete

• Create: Submit a request to create a new page.
• Read: Assign to a new partner for review.
• Update: Needs updates with notes on next steps.
• Delete: Delete the page.
• Complete: Everything is fresh, clear, and accessible.

No additional action is needed yet. This first pass is meant to help develop a backlog.

Validators Section Audit

Complete audit for Validator Guide section in docs.celo.org.

What to do
Review docs to ensure they are fresh, clear, and accessible

• Fresh: Is everything written up to date and accurate?
• Clear: Is everything clearly explained?
• Accessible: Is everything well organized and easy to find?

Key questions

• What do we have that we need?
• What do we have that we don’t need?
• What do we don’t have that we need?

Add tag when complete

• Create: Submit a request to create a new page.
• Read: Assign to a new partner for review.
• Update: Needs updates with notes on next steps.
• Delete: Delete the page.
• Complete: Everything is fresh, clear, and accessible.

No additional action is needed yet. This first pass is meant to help develop a backlog.

Sending CELO & cUSD

Audit https://docs.celo.org/developer-guide/start/hellocelo

Metamask Gas Update

New PR that updated docs. Make sure these changes are caught in the docs update

celo-org/celo-monorepo#8103

Convert the command line interface docs to docusaurus

• The relevant docs are inside of docs/command-line-interface/.
• The urls should match our current docs starting at https://docs.celo.org/command-line-interface/introduction.
• We should decide what a matching document would be title for the current category in gitbook at https://docs.celo.org/command-line-interface/commands.

Build i18n scaffolding

Design review & feedback

update Wallets doc page

Update the wallets page to include the updates made here

celo-org/celo-monorepo@2580838#diff-ae04f052d7be6458ee093327ccd1c092565224fdc1bc95427add2353cc8e69a9

and here
celo-org/celo-monorepo@7c31d37#diff-ae04f052d7be6458ee093327ccd1c092565224fdc1bc95427add2353cc8e69a9

Define list of teams and people who need to be informed and included in review process.

DappKit Trufflebox

Audit https://docs.celo.org/developer-guide/start/hello-mobile

Change the favicon to a Celo one

Define and execute monorepo docs deprecaton process

Customize the docusaurus sidebar to allow categories to have associated files to present

update "Celo for ETH devs" page

Update the docs to reflect these changes

celo-org/celo-monorepo#8280

Build an i18n compatible graphic component

The footer in docusaurus doesn't look very good

Alternative Architecture Prototype (GitBook)

Create a prototype of potential Docs 2.0 architecture.

Research i18n docusaurus implementation

Convert the Celo protocol docs over to docusaurus.

Important Information Section Audit

Complete audit for Important Information section in docs.celo.org.

What to do
Review docs to ensure they are fresh, clear, and accessible

• Fresh: Is everything written up to date and accurate?
• Clear: Is everything clearly explained?
• Accessible: Is everything well organized and easy to find?

Key questions

• What do we have that we need?
• What do we have that we don’t need?
• What do we don’t have that we need?

Add tag when complete

• Create: Submit a request to create a new page.
• Read: Assign to a new partner for review.
• Update: Needs updates with notes on next steps.
• Delete: Delete the page.
• Complete: Everything is fresh, clear, and accessible.

No additional action is needed yet. This first pass is meant to help develop a backlog.

add search

Add search to docusaurus site. https://docusaurus.io/docs/search

Architecture Mindmap and Outline

Create mindmap and outline proposal for Docs 2.0 architecture.

Welcome Section Audit

Complete audit for Welcome section in docs.celo.org.

What to do
Review docs to ensure they are fresh, clear, and accessible

• Fresh: Is everything written up to date and accurate?
• Clear: Is everything clearly explained?
• Accessible: Is everything well organized and easy to find?

Key questions

• What do we have that we need?
• What do we have that we don’t need?
• What do we don’t have that we need?

Add tag when complete

• Create: Submit a request to create a new page.
• Read: Assign to a new partner for review.
• Update: Needs updates with notes on next steps.
• Delete: Delete the page.
• Complete: Everything is fresh, clear, and accessible.

No additional action is needed yet. This first pass is meant to help develop a backlog.

Convert the important information docs to docusaurus.

Manually assign ids to markdown front matter

Finalize Documentation Architecture

Two outlines proposed for Doc Architecture here.

Need to finalize overview, pros & cons, and finalize an outline for documentation 2.0 architecture.

Tutorials Section Audit

Complete audit for Celo Codebase section in docs.celo.org.

What to do
Review docs to ensure they are fresh, clear, and accessible

• Fresh: Is everything written up to date and accurate?
• Clear: Is everything clearly explained?
• Accessible: Is everything well organized and easy to find?

Key questions

• What do we have that we need?
• What do we have that we don’t need?
• What do we don’t have that we need?

Add tag when complete

• Create: Submit a request to create a new page.
• Read: Assign to a new partner for review.
• Update: Needs updates with notes on next steps.
• Delete: Delete the page.
• Complete: Everything is fresh, clear, and accessible.

No additional action is needed yet. This first pass is meant to help develop a backlog.

Automate or solve docs code gen

contractkit and the cli:

https://docs.celo.org/command-line-interface/commands

https://docs.celo.org/developer-guide/sdk-code-reference

Migrating all docs that changed since the docs were forked

Convert the Celo wallet docs over to docusaurus.

Getting Started Section Audit

Complete audit for Getting Started section in docs.celo.org.

What to do
Review docs to ensure they are fresh, clear, and accessible

• Fresh: Is everything written up to date and accurate?
• Clear: Is everything clearly explained?
• Accessible: Is everything well organized and easy to find?

Key questions

• What do we have that we need?
• What do we have that we don’t need?
• What do we don’t have that we need?

Add tag when complete

• Create: Submit a request to create a new page.
• Read: Assign to a new partner for review.
• Update: Needs updates with notes on next steps.
• Delete: Delete the page.
• Complete: Everything is fresh, clear, and accessible.

No additional action is needed yet. This first pass is meant to help develop a backlog.

Integrations Section Audit

Complete audit for Command Line Interface section in docs.celo.org.

What to do
Review docs to ensure they are fresh, clear, and accessible

• Fresh: Is everything written up to date and accurate?
• Clear: Is everything clearly explained?
• Accessible: Is everything well organized and easy to find?

Key questions

• What do we have that we need?
• What do we have that we don’t need?
• What do we don’t have that we need?

Add tag when complete

• Create: Submit a request to create a new page.
• Read: Assign to a new partner for review.
• Update: Needs updates with notes on next steps.
• Delete: Delete the page.
• Complete: Everything is fresh, clear, and accessible.

No additional action is needed yet. This first pass is meant to help develop a backlog.

Architecture Plan

Finalize plan for Celo Docs 2.0 architecture.

Convert the community docs to docusaurus.

Set up subdomain docs.celo.org from gitbook on netlify

work with security or dev ops to setup subdomain

docs CNAME celo-docs.netlify.app.

Build a generic YouTube component for embedded YouTube videos.

Contributors Section Audit

Complete audit for Community section in docs.celo.org.

What to do
Review docs to ensure they are fresh, clear, and accessible

• Fresh: Is everything written up to date and accurate?
• Clear: Is everything clearly explained?
• Accessible: Is everything well organized and easy to find?

Key questions

• What do we have that we need?
• What do we have that we don’t need?
• What do we don’t have that we need?

Add tag when complete

• Create: Submit a request to create a new page.
• Read: Assign to a new partner for review.
• Update: Needs updates with notes on next steps.
• Delete: Delete the page.
• Complete: Everything is fresh, clear, and accessible.

No additional action is needed yet. This first pass is meant to help develop a backlog.

Create a line separator component and replace the gitbook markdown lines with it

Update Using MetaMask with Celo

Update Using MetaMask with Celo to match updates previously made to Docs 1.0.

Build a page reference button to match the gitbook look

Convert the validator-guide to docusaurus.

Code Examples Start

Audit https://docs.celo.org/developer-guide/start

Validator Guide Section Audit

Complete audit for Validator Guide section in docs.celo.org.

What to do
Review docs to ensure they are fresh, clear, and accessible

• Fresh: Is everything written up to date and accurate?
• Clear: Is everything clearly explained?
• Accessible: Is everything well organized and easy to find?

Key questions

• What do we have that we need?
• What do we have that we don’t need?
• What do we don’t have that we need?

Add tag when complete

• Create: Submit a request to create a new page.
• Read: Assign to a new partner for review.
• Update: Needs updates with notes on next steps.
• Delete: Delete the page.
• Complete: Everything is fresh, clear, and accessible.

No additional action is needed yet. This first pass is meant to help develop a backlog.

Convert the developer guide to docusaurus.

The relevant documentation in the gitbook format is inside of docs/developer-resources. The urls should match the current documentation starting with https://docs.celo.org/developer-guide/overview.

Documentation Strategy

Complete Developer Documentation Strategy.

Deploy a Contract

Audit https://docs.celo.org/developer-guide/start/hellocontracts