mesg-foundation / docs Goto Github PK

marketplace

• add description
• list of features
• ownership of service
• buy access of a service
• buy ownership of a service
• get information from the marketplace
• publish to the marketplace

• remove install script (doesn't work well on Linux)
• add explanation for the JS CLI
• update the docker command line

This page should explain the architecture with schema.

When reloading a page of an API (eg: https://docs.mesg.com/api/service.html) the details are not loaded but it's correctly working if we navigate to the page

This

instead of

The docs need to be updated to show the new service single outputs feature

The tuto is not using the template based command service init.
It need to be updated to use it.
Make sure also to keep the files organization of the template.

In page https://docs.mesg.com/guide/process/process-file.html#steps

• process key to name
• nested data
• nested reference (but still not merged)
• nodeKey to refKey (also in execution)

We could use this plugin for that https://github.com/ulivz/vuepress-plugin-flowchart

We should add a network guide or at least some info in the installation page:

• how to start with the testnet
• how to start with the local network
• how to connect multiple node together on a local network

Every time we display some code, we could display them using this plugin
https://github.com/padarom/vuepress-plugin-code-switcher

The script to generate the documentation for the cli is not working correctly with the update of the different/latest version

go get: no install location for directory /Users/antho/go/pkg/mod/github.com/mesg-foundation/[email protected] outside GOPATH
        For more details see: 'go help gopath'

I don't have the same alignment on the homepage from the local dev version and the one publish on docs.mesg.com

I think the local version is the correct

local:

published:

that's not only on the homepage:
local:

published:

https://docs.mesg.com/guide/service/listen-for-tasks.html#task-definitions

https://docs.mesg.com/tutorials/erc20-transfer-notifications/send-emails-with-sendgrid.html#introduction

https://vuepress.tools/plugins/seo.html

The current homepage is still with old tagline and key points:

Rapid feature integration
Plug features into any application - we are even using MESG to build MESG itself.

Multi-language applications
MESG mixes a gRPC API and a container based module approach to offer the most flexibility to developers.

Event-driven architecture
Event-driven architecture allows any services to produce events and react to other with loosely coupled dependencies.

Autonomous workflows
MESG features flow-based programming to create reactive applications with endless possibility.

Hybrid decentralized applications
MESG’s decentralized network will enable you to run centralized services in decentralized trustless environments.

Scalable applications
The mix of an Event-driven architecture and a decentralized network offers an high scalability and redundancy infrastructure

@willcreatedit can you take a look and update it?

Like in core.

The PR #68 adds the process guide but without any example.

We could use the example that is already used in the website or this gist or create a new abstract example that just shows the different possibilities of the process file https://docs.mesg.com/guide/process/process-file.html.

Vuepress has been updated to a stable version, we should update it and this might probably fix issues we have in the design

The example and table doesn't show the executionTags

https://docs.mesg.com/guide/application/execute-a-task.html#why-execute-a-service-s-task

The docs doesn't mention the .mesgignore files.
Same for .dockerignore.

reported on Discord by joveee

https://docs.mesg.com/service/listen-for-tasks/ - this link is broken (from here - https://docs.mesg.com/guide/service/what-is-a-service.html#receiving-tasks)

The PR #68 add the guide of the process but doesn't have a nice schema of process.

listenResult accept outputFilter only if taskFilter is present, this is not explicitly said in the documentation

It will be better if the deployment script can also download the proto and create the docs

Docs has been updated but not the source code
mesg-foundation/engine#698

Started in this branch: https://github.com/mesg-foundation/docs/tree/update-proto-scripts
Need to finish to improve the templates to output the proto api and types nicely.

We should add the schema that used to be on the mesg.com website to the intro page of docs.

The edit link at the bottom of every page link to the wrong url.

Current links:
https://github.com/mesg-foundation/docs/edit/dev/docs/tutorials/README.md

Should be:
https://github.com/mesg-foundation/docs/edit/master/tutorials/README.md

Lists are not aligned correctly in the menu but also on any page.

Before:

After:

The env are not present in the guide:
https://docs.mesg.com/guide/service/dockerize-the-service.html#add-a-configuration-and-dependencies

When the new version of the engine is released with the new commands lines and everything, let's add those endpoints to the docs:

• https://rpc.explorer.testnet.mesg.com
• https://lcd.explorer.testnet.mesg.com

We need to add the documentation for the advanced use of the engine.

We should add the information about:

• Tendermint port (26657)
• Prometheus port (26660)

A new testnet has been created https://github.com/mesg-foundation/networks/pull/7, we need to make sure to reflect this change in the documentation

The news link from the docs menu should be removed. Eg It's useless to put a link to the facebook page...

And there is not link to mesg.com, we should add one.

The future update of mesg-js change some parameters in the application side. the guide and tuto need to be updated.

Because of mesg-foundation/engine#928,

volumesfrom needs to be renamed to volumesFrom in guide, and also generate the doc api.

https://docs.mesg.com/guide/service/dockerize-the-service.html#add-a-configuration-and-dependencies