docs: align Stellar vault curator guide with CLI#508
Conversation
📝 WalkthroughSummary
Human review focus
WalkthroughThe curator documentation was rewritten for Stellar vault operations, while the Soroban vault CLI now performs deployment-wide TTL extension through protocol instance and WASM code commands. CLI help, README guidance, and tests were updated for revised governance, withdrawal, accounting, and TTL behavior. ChangesStellar vault operations
Estimated code review effort: 3 (Moderate) | ~25 minutes Possibly related PRs
Suggested labels: Suggested reviewers: Sequence Diagram(s)sequenceDiagram
participant Curator
participant VaultCLI
participant StellarCLI
participant SorobanContracts
Curator->>VaultCLI: run extend-ttl
VaultCLI->>StellarCLI: extend contract instances
VaultCLI->>StellarCLI: extend protocol WASM code
StellarCLI->>SorobanContracts: submit and simulate contract extend
SorobanContracts-->>VaultCLI: return transaction output
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
Comment |
peer2f00l
left a comment
There was a problem hiding this comment.
Only blocking on the extend TTL comment
There was a problem hiding this comment.
Warning
CodeRabbit couldn't request changes on this pull request because it doesn't have sufficient GitHub permissions.
Please grant CodeRabbit Pull requests: Read and write permission and re-run the review.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/src/curator-guide.md`:
- Line 14: Remove the blank line inside the blockquote in curator-guide.md by
deleting its `>` marker or keeping the blockquote continuous, ensuring the
Markdownlint MD028 violation is resolved.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 2d72a5bf-cb88-480b-92de-f533ef979dde
📒 Files selected for processing (7)
docs/src/SUMMARY.mddocs/src/curator-guide.mddocs/src/index.mdtools/soroban-vault-cli/README.mdtools/soroban-vault-cli/src/cli.rstools/soroban-vault-cli/src/commands.rstools/soroban-vault-cli/src/stellar.rs
Summary
tmplr-soroban-vaultworkflowWhy
The curator guide described a NEAR-oriented client workflow even though the supported curator surface is the Stellar vault operations CLI. It also diverged from current contract mechanics around Sentinel-only pausing, allocator-authorized queued-withdrawal execution, proposal timing, market bindings, and adapter accounting.
This change makes the public documentation match the deployed Stellar operating model and explicitly scopes the separate NEAR vault executor out of the curator runbook.
Operator impact
Curators and keepers now have one task-oriented guide covering:
Validation
cargo fmt -p templar-soroban-vault-cli -- --checkCARGO_TARGET_DIR=/data/tmp/templar-stellar-curator-target cargo test -p templar-soroban-vault-cli— 75 passedmdbook build docswith the configured linkcheck renderergit diff --check129255 <= 131072bytesThis change is