Skip to content

feat(docs): Add aligned-cli readme - #1590

Merged
JuArce merged 10 commits into
stagingfrom
feat/aligned-cli-doc
Jan 8, 2025
Merged

feat(docs): Add aligned-cli readme#1590
JuArce merged 10 commits into
stagingfrom
feat/aligned-cli-doc

Conversation

@PatStiles

@PatStilesPatStiles commented Dec 6, 2024

Copy link
Copy Markdown
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

@PatStilesPatStiles self-assigned this Dec 9, 2024
MarcosNicolau
MarcosNicolau reviewed Dec 9, 2024
View reviewed changes
Comment threaddocs/3_guides/9_aligned_cli.md Outdated
Comment threaddocs/3_guides/9_aligned_cli.md Outdated
Comment threaddocs/3_guides/9_aligned_cli.md Outdated
Comment threaddocs/3_guides/9_aligned_cli.md Outdated
Comment threaddocs/3_guides/9_aligned_cli.md Outdated
Comment threaddocs/3_guides/9_aligned_cli.md Outdated
Comment threaddocs/3_guides/9_aligned_cli.md Outdated
Comment threaddocs/3_guides/9_aligned_cli.md Outdated
Comment threaddocs/3_guides/9_aligned_cli.md Outdated
Comment threaddocs/3_guides/9_aligned_cli.md Outdated
@PatStilesPatStiles changed the title fear(docs): Add aligned-cli readmefeat(docs): Add aligned-cli readmeDec 10, 2024
MarcosNicolau
MarcosNicolau reviewed Dec 10, 2024
View reviewed changes

@MarcosNicolauMarcosNicolau left a comment

Copy link
Copy Markdown
Collaborator

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.

JuArce
JuArce requested changes Dec 10, 2024
View reviewed changes

@JuArceJuArce left a comment

Copy link
Copy Markdown
Collaborator

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

PatStiles commented Dec 10, 2024

Copy link
Copy Markdown
ContributorAuthor

There is missing to update the summary.MD

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

JuArce
JuArce requested changes Dec 23, 2024
View reviewed changes
Comment threaddocs/3_guides/9_aligned_cli.md Outdated
Comment threaddocs/3_guides/9_aligned_cli.md Outdated
Comment threaddocs/3_guides/9_aligned_cli.md Outdated
Comment threaddocs/3_guides/9_aligned_cli.md Outdated
Comment threaddocs/3_guides/9_aligned_cli.md Outdated
Comment threaddocs/3_guides/9_aligned_cli.md Outdated
Comment threaddocs/3_guides/9_aligned_cli.md Outdated
@uri-99uri-99 mentioned this pull request Jan 6, 2025
Merged
17 tasks
@uri-99
uri-99 changed the base branch from staging to feat/sdk-pricingJanuary 6, 2025 17:15
@uri-99
uri-99 changed the base branch from feat/sdk-pricing to stagingJanuary 6, 2025 17:15
@uri-99
uri-99 changed the base branch from staging to testnetJanuary 6, 2025 20:38
@uri-99
uri-99 changed the base branch from testnet to stagingJanuary 6, 2025 20:39
@uri-99
uri-99 changed the base branch from staging to testnetJanuary 6, 2025 20:39
@PatStiles
PatStiles changed the base branch from testnet to stagingJanuary 8, 2025 14:34
avilagaston9
avilagaston9 approved these changes Jan 8, 2025
View reviewed changes

@avilagaston9avilagaston9 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

Comment threaddocs/3_guides/9_aligned_cli.md Outdated
@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 stagingJan 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@uri-99@JuArce
feat(docs): Add aligned-cli readme (#1590)
af27051
Co-authored-by: Urix <43704209+uri-99@users.noreply.github.com>
Co-authored-by: JuArce <52429267+JuArce@users.noreply.github.com>
PatStiles added a commit that referenced this pull request Jan 9, 2025
@PatStiles@uri-99@JuArce
feat(docs): Add aligned-cli readme (#1590)
bd6adf0
Co-authored-by: Urix <43704209+uri-99@users.noreply.github.com>
Co-authored-by: JuArce <52429267+JuArce@users.noreply.github.com>
PatStiles added a commit that referenced this pull request Jan 10, 2025
@PatStiles@uri-99@JuArce
feat(docs): Add aligned-cli readme (#1590)
6f46498
Co-authored-by: Urix <43704209+uri-99@users.noreply.github.com>
Co-authored-by: JuArce <52429267+JuArce@users.noreply.github.com>
PatStiles added a commit that referenced this pull request Jan 10, 2025
@PatStiles@uri-99@JuArce
feat(docs): Add aligned-cli readme (#1590)
abe56e4
Co-authored-by: Urix <43704209+uri-99@users.noreply.github.com>
Co-authored-by: JuArce <52429267+JuArce@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JuArceJuArceJuArce approved these changes
@MarcosNicolauMarcosNicolauMarcosNicolau left review comments
+2 more reviewers
@uri-99uri-99uri-99 approved these changes
@avilagaston9avilagaston9avilagaston9 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@PatStilesPatStiles

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@PatStiles@uri-99@JuArce@avilagaston9@MarcosNicolau