Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add EXPERIMENTAL disclaimer to specific arguments and command #235

Open
endersonmaia opened this issue Apr 3, 2025 · 0 comments
Open

Add EXPERIMENTAL disclaimer to specific arguments and command #235

endersonmaia opened this issue Apr 3, 2025 · 0 comments

Comments

@endersonmaia
Copy link
Contributor

endersonmaia commented Apr 3, 2025

Context

We should be explicit which commands and arguments are experimental in the cli docs and output.

Some features that are being integrated into cartesi/cli v2 are:

  • coprocessor command
  • espresso-reader integration

Considering those initiatives are still experimental in the official docs point of view, we should also align the cartesi/cli.

Proposal

Add a EXPERIMENTAL text for commands and arguments that are considered exprimental.

Ex,:

cartesi --help
Usage: cartesi [options] [command]

Options:
  -V, --version            output the version number
  -h, --help               display help for command

Commands:
  coprocessor [options] EXPERIMENTAL
...

CHANGELOG should also be updated to inform which feature is experimental, and remove this disclaimer when it's considered official support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant