From 95745a407d2abf764de1607c3a5a2a2c21adf178 Mon Sep 17 00:00:00 2001 From: Lim Junxue Date: Fri, 26 Jul 2024 16:35:50 +0800 Subject: [PATCH] Change mecanywhere to meca --- README.md | 8 ++++---- docs/source/index.rst | 6 +++--- docs/source/pages/user_guides/example_tasks.rst | 2 +- docs/source/pages/user_guides/host_guide.rst | 6 +++--- docs/source/pages/user_guides/task_dev_guide.rst | 2 +- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 739cc3c..2ada3dd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# MECAnywhere Services +# MECA Services Table of Contents @@ -11,7 +11,7 @@ Table of Contents # Overview -This repository contains the services for the MECAnywhere project that are used to interact with pymeca and the smart contracts. Use the pymeca-actors to join the MECAnywhere ecosystem now! +This repository contains the services for the MECA project that are used to interact with pymeca and the smart contracts. Use the pymeca-actors to join the MECA ecosystem now! ### Architecture @@ -19,12 +19,12 @@ https://www.figma.com/file/JkjN5hBQYfCFEMpc2QS4eH/MECAnywhere-Architecture-Diagr ### Services -> Open https://sbip-sg.github.io/mec_anywhere/ for online documentation + user guides. +> Open https://sbip-sg.github.io/meca/ for online documentation + user guides. - did-go - Decentalized Identity (DID) service written in Golang - example-tasks - - Example tasks for the MECAnywhere platform + - Example tasks for the MECA platform - [README to build tasks](example-tasks/README.md) - Pymeca actors - Template actors that use pymeca library to interact with the smart contracts. These come in the form of CLI. diff --git a/docs/source/index.rst b/docs/source/index.rst index c00805d..b4f612e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,12 +1,12 @@ -.. MECAnywhere documentation master file, created by +.. MECA documentation master file, created by sphinx-quickstart on Thu Jan 4 11:25:18 2024. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to MECAnywhere's documentation! +Welcome to MECA's documentation! ======================================= -This is for developers working on MECAnywhere backend. User guides are also available under Contents. +This is for developers working on MECA backend. User guides are also available under Contents. .. toctree:: diff --git a/docs/source/pages/user_guides/example_tasks.rst b/docs/source/pages/user_guides/example_tasks.rst index 283cf2b..867cb7b 100644 --- a/docs/source/pages/user_guides/example_tasks.rst +++ b/docs/source/pages/user_guides/example_tasks.rst @@ -4,7 +4,7 @@ Building tasks ============== This guide will walk you through the development of a task container that a task developer can upload. -Example tasks are provided in `example tasks README `__. +Example tasks are provided in `example tasks README `__. Each folder must contain all of the files listed in the structure below. .. include:: ../../../../example-tasks/README.md diff --git a/docs/source/pages/user_guides/host_guide.rst b/docs/source/pages/user_guides/host_guide.rst index 97cbfc5..3835666 100644 --- a/docs/source/pages/user_guides/host_guide.rst +++ b/docs/source/pages/user_guides/host_guide.rst @@ -15,8 +15,8 @@ Introduction The host is the service that executes tasks submitted by clients. This guide will walk you through the process of setting up and managing a -host using the CLI. You can also check out the `MECAnywhere Desktop -application `__ for a +host using the CLI. You can also check out the `MECA Desktop +application `__ for a more user-friendly experience. Installation @@ -27,7 +27,7 @@ Installation website `__. 2. Start and serve the host container. (see pymeca-actors readme) 3. Build the `task - executor `__. + executor `__. 4. Ensure that you have a valid connection to IPFS for retrieval (see https://docs.ipfs.tech/quickstart/retrieve/#ipfs-retrieval-methods). diff --git a/docs/source/pages/user_guides/task_dev_guide.rst b/docs/source/pages/user_guides/task_dev_guide.rst index 9a9ff98..5b2ef6b 100644 --- a/docs/source/pages/user_guides/task_dev_guide.rst +++ b/docs/source/pages/user_guides/task_dev_guide.rst @@ -25,7 +25,7 @@ Installation on your machine. You can download Docker from the `official Docker website `__. 2. Start and serve the task developer container. (see `pymeca-actors - readme `__) + readme `__) 3. Ensure that you have a valid connection to IPFS for uploading. (see `IPFS installation docs `__) You can also use the docker image from IPFS following instructions in pymeca-actors readme.