cartesi / docs Goto Github PK

Provide documentation for this flag in addition to the help command of cartesi-machine.

The Output Validity Proof feature has a number of components renamed as per cartesi/rollups#122 The requirement is to update the docs accordingly.

From here, just before the summary of this section.

Naturally, this optimism comes paired up with financial incentives for honest behavior and guarantees that, unless the proposed false state is undisputed for a significant amount of time, it will never get accepted.

Sounds like the honest behavior won't get accepted?

Once all docs are ready for 1.0, we need to deploy a PR to enable 1.0 in the version selection.

As per https://discordapp.com/channels/600597137524391947/1108384164501266443/1126461496034070639

Context: Cartesi Rollups v1 will not be deployed on Ethereum Goerli (Testnet). The Testnet deployment will be done only on Sepolia for Ethereum.
⚠️Optimism Goerli and Arbitrum Goerli will be supported.

@nicocartesi 👀

Following the instructions on:
https://docs.cartesi.io/machine/host/cmdline/#rolling-cartesi-machine-templates

oshiro@playground:~$ cartesi-machine \
    --rollup \
    --flash-drive=label:calc,filename:calc.ext2 \
    --store="rolling-calculator-template" \
    --assert-rolling-template \
    -- /mnt/calc/calc.sh
lua5.3: /opt/cartesi/bin/cartesi-machine.lua:799: unrecognized option --assert-rolling-template

Context:
Cartesi will not be a validator anymore, with the exception for the honeypot. So it does not make sense to continue offering our cloud-based deployment and execution infrastructure.

Solution:
Dev will have to deploy their cartesi nodes. The README on rollups-examples repo provides instructions on how to run a Cartesi node for a Cartesi DApp. That said, we will need to update the "Deplying DApps" section on Cartesi docs.

@nicocartesi 👀

Documentation issue

• Documentation improvement

Is there a specific documentation page you are reporting?

It is an update to align with Cartesi's new branding. The screenshots used in the tutorials for staking use the previous branding colours. We also want to include an embedded video shared by the marketing team.

Video to be embedded: https://www.youtube.com/watch?v=7VAYt3qHpSI

The video should be embedded in the staking section under the title "How to Stake"

URL to be updated:

• https://docs.cartesi.io/earn-ctsi/staking/
• https://docs.cartesi.io/earn-ctsi/run-node/
• https://docs.cartesi.io/earn-ctsi/public-pool/

Additional context or description

The tutorial documentation is located in the Cartesi documentation repo under docs/earn-ctsi

Context:
the deployment landscape is different from that of couple months ago. Cartesi will not be a validator any longer, with the exception of the honeypot. There will be not a Cartesi validator node running for examples any longer. Another validator should do this instead.
Solution:
Docs should not provide any links to online endpoints for rollups-examples and all contet where there are those links should be rewritten. For example, the section Quick Start where we can find instructions on how to interact with remotely deployed examples: https://docs.cartesi.io/cartesi-rollups/build-dapps/run-dapp/

@nicocartesi 👀

Description:

In the Cartesi documentation, the footer text is not visible when the documentation theme is changed from dark to light. The issue can be observed here.

Proposed Solution:

To address this issue, we propose changing the text color from white to black when the documentation theme is switched. This adjustment is necessary to ensure that the footer text remains visible regardless of the selected theme.

Screenshot:

Dark Mode:

Light Mode:

Would you like to work on this issue?

• Yes
• No

The links to Github repos throughout the docs are not using tags, and some are outdated. I believe we should always use tags to ensure the links remain valid after new releases.

Example:

• At the end of the "Assets handling" page, there is a link to the rollups repository where one can find a list of the Portals and their corresponding encodings. This is pointing to https://github.com/cartesi/rollups#portals, but that is no longer the location of that information (it is now in https://github.com/cartesi/rollups-contracts/tree/v1.1.0#portals). If tags had been used it would still be working (e.g., https://github.com/cartesi/rollups/tree/v1.0.0#portals)

I expect there to be a lot of references to Github repos without tags around the docs, so a thorough search and replace would be welcome.

We need to create a set of tutorials on ERC-20, ERC-721 and Ether.

Hi guys!

Where I can find the doc about the file dapp.json?
https://github.com/Calindra/rollups-examples/blob/main/echo-rust/dapp.json