Skip to content

Conversation

@PatStiles
Copy link
Contributor

Aligned CLI readme

Description

Adds an readme for the aligned CLI that displays and describes all its flags and parameters. This is intended to be used in alongside the other examples within the documentation for usage.

A separate PR should be done to make the naming conventions throughout the repo consistent. ref: #1589 . It would be recommended to do this in parts as it may introduce breaking changes.

Type of change

Please delete options that are not relevant.

  • New feature

Checklist

  • “Hotfix” to testnet, everything else to staging
  • Linked to Github Issue
  • This change depends on code or research by an external entity
    • Acknowledgements were updated to give credit
  • Unit tests added
  • This change requires new documentation.
    • Documentation has been added/updated.
  • This change is an Optimization
    • Benchmarks added/run
  • Has a known issue
  • If your PR changes the Operator compatibility (Ex: Upgrade prover versions)
    • This PR adds compatibility for operator for both versions and do not change batcher/docs/examples
    • This PR updates batcher and docs/examples to the newer version. This requires the operator are already updated to be compatible

@PatStiles PatStiles self-assigned this Dec 9, 2024
@PatStiles PatStiles changed the title fear(docs): Add aligned-cli readme feat(docs): Add aligned-cli readme Dec 10, 2024
Copy link
Member

@MarcosNicolau MarcosNicolau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! We should wait until the other CLI prs get merged before merging one.

Copy link
Collaborator

@JuArce JuArce left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is missing to update the summary.MD

@PatStiles
Copy link
Contributor Author

There is missing to update the summary.MD

Cambio! @JuArce I also added a missing link for Submitting Batch without Batcher

@uri-99 uri-99 changed the base branch from staging to feat/sdk-pricing January 6, 2025 17:15
@uri-99 uri-99 changed the base branch from feat/sdk-pricing to staging January 6, 2025 17:15
@uri-99 uri-99 changed the base branch from staging to testnet January 6, 2025 20:38
@uri-99 uri-99 changed the base branch from testnet to staging January 6, 2025 20:39
@uri-99 uri-99 changed the base branch from staging to testnet January 6, 2025 20:39
@PatStiles PatStiles changed the base branch from testnet to staging January 8, 2025 14:34
Copy link
Contributor

@avilagaston9 avilagaston9 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@JuArce JuArce enabled auto-merge January 8, 2025 18:28
@JuArce JuArce disabled auto-merge January 8, 2025 20:10
@JuArce JuArce merged commit 76e4267 into staging Jan 8, 2025
@JuArce JuArce deleted the feat/aligned-cli-doc branch January 8, 2025 20:10
PatStiles added a commit that referenced this pull request Jan 9, 2025
PatStiles added a commit that referenced this pull request Jan 9, 2025
PatStiles added a commit that referenced this pull request Jan 10, 2025
PatStiles added a commit that referenced this pull request Jan 10, 2025
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

Successfully merging this pull request may close these issues.

6 participants