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

chore: Update docs #8970

Merged
merged 5 commits into from
Oct 25, 2024

Fix a typo

83c6e68
Select commit
Loading
Failed to load commit list.
Merged

chore: Update docs #8970

Fix a typo
83c6e68
Select commit
Loading
Failed to load commit list.
Mergify / Queue: Embarked in merge queue succeeded Oct 25, 2024 in 0s

The pull request embarked with main (f5e872a) will be merged soon

Required conditions for merge:

  • #approved-reviews-by >= 1 [🛡 GitHub branch protection]
  • #approved-reviews-by >= 1 [🛡 GitHub repository ruleset rule]
  • #changes-requested-reviews-by = 0 [🛡 GitHub branch protection]
  • #changes-requested-reviews-by = 0 [🛡 GitHub repository ruleset rule]
  • #review-threads-unresolved = 0 [🛡 GitHub repository ruleset rule]
  • base=main
  • any of [🛡 GitHub branch protection]:
    • check-success = Test stable on ubuntu-latest
    • check-neutral = Test stable on ubuntu-latest
    • check-skipped = Test stable on ubuntu-latest
  • any of [🛡 GitHub branch protection]:
    • check-success = Test CD custom Docker config file / Test custom-conf in Docker
    • check-neutral = Test CD custom Docker config file / Test custom-conf in Docker
    • check-skipped = Test CD custom Docker config file / Test custom-conf in Docker
  • any of [🛡 GitHub repository ruleset rule]:
    • check-skipped = Rustfmt
    • check-neutral = Rustfmt
    • check-success = Rustfmt
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = mergefreeze
    • check-neutral = mergefreeze
    • check-skipped = mergefreeze
  • any of [🛡 GitHub repository ruleset rule]:
    • check-skipped = Clippy
    • check-neutral = Clippy
    • check-success = Clippy
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Test with fake activation heights
    • check-neutral = Test with fake activation heights
    • check-skipped = Test with fake activation heights
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Test all
    • check-neutral = Test all
    • check-skipped = Test all
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Check deny.toml bans
    • check-neutral = Check deny.toml bans
    • check-skipped = Check deny.toml bans
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Check deny.toml bans --all-features
    • check-neutral = Check deny.toml bans --all-features
    • check-skipped = Check deny.toml bans --all-features
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Check deny.toml bans --features default-release-binaries
    • check-neutral = Check deny.toml bans --features default-release-binaries
    • check-skipped = Check deny.toml bans --features default-release-binaries
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Check deny.toml sources
    • check-neutral = Check deny.toml sources
    • check-skipped = Check deny.toml sources
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Check deny.toml sources --all-features
    • check-neutral = Check deny.toml sources --all-features
    • check-skipped = Check deny.toml sources --all-features
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Check deny.toml sources --features default-release-binaries
    • check-neutral = Check deny.toml sources --features default-release-binaries
    • check-skipped = Check deny.toml sources --features default-release-binaries
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Check Cargo.lock is up to date
    • check-neutral = Check Cargo.lock is up to date
    • check-skipped = Check Cargo.lock is up to date
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Install zebrad from lockfile without cache on ubuntu-latest
    • check-neutral = Install zebrad from lockfile without cache on ubuntu-latest
    • check-skipped = Install zebrad from lockfile without cache on ubuntu-latest
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Test checkpoint sync from empty state
    • check-neutral = Test checkpoint sync from empty state
    • check-skipped = Test checkpoint sync from empty state
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Zebra checkpoint update / Run sync-past-checkpoint test
    • check-neutral = Zebra checkpoint update / Run sync-past-checkpoint test
    • check-skipped = Zebra checkpoint update / Run sync-past-checkpoint test
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Zebra tip JSON-RPC / Run fully-synced-rpc test
    • check-neutral = Zebra tip JSON-RPC / Run fully-synced-rpc test
    • check-skipped = Zebra tip JSON-RPC / Run fully-synced-rpc test
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Build tower-batch-control crate
    • check-neutral = Build tower-batch-control crate
    • check-skipped = Build tower-batch-control crate
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Build zebra-chain crate
    • check-neutral = Build zebra-chain crate
    • check-skipped = Build zebra-chain crate
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Build zebra-consensus crate
    • check-neutral = Build zebra-consensus crate
    • check-skipped = Build zebra-consensus crate
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Build zebra-grpc crate
    • check-neutral = Build zebra-grpc crate
    • check-skipped = Build zebra-grpc crate
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Build zebra-network crate
    • check-neutral = Build zebra-network crate
    • check-skipped = Build zebra-network crate
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Build zebra-node-services crate
    • check-neutral = Build zebra-node-services crate
    • check-skipped = Build zebra-node-services crate
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Build zebra-rpc crate
    • check-neutral = Build zebra-rpc crate
    • check-skipped = Build zebra-rpc crate
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Build zebra-scan crate
    • check-neutral = Build zebra-scan crate
    • check-skipped = Build zebra-scan crate
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Build zebra-script crate
    • check-neutral = Build zebra-script crate
    • check-skipped = Build zebra-script crate
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Build tower-fallback crate
    • check-neutral = Build tower-fallback crate
    • check-skipped = Build tower-fallback crate
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Build zebra-state crate
    • check-neutral = Build zebra-state crate
    • check-skipped = Build zebra-state crate
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Build zebra-test crate
    • check-neutral = Build zebra-test crate
    • check-skipped = Build zebra-test crate
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Build zebra-utils crate
    • check-neutral = Build zebra-utils crate
    • check-skipped = Build zebra-utils crate
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Zebra tip update / Run update-to-tip test
    • check-neutral = Zebra tip update / Run update-to-tip test
    • check-skipped = Zebra tip update / Run update-to-tip test
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Test beta on ubuntu-latest
    • check-neutral = Test beta on ubuntu-latest
    • check-skipped = Test beta on ubuntu-latest
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Test stable on ubuntu-latest
    • check-neutral = Test stable on ubuntu-latest
    • check-skipped = Test stable on ubuntu-latest
  • any of [🛡 GitHub repository ruleset rule]:
    • check-skipped = Build CI Docker / Build images
    • check-neutral = Build CI Docker / Build images
    • check-success = Build CI Docker / Build images
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = submit block / Run submit-block test
    • check-neutral = submit block / Run submit-block test
    • check-skipped = submit block / Run submit-block test
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = get block template / Run get-block-template test
    • check-neutral = get block template / Run get-block-template test
    • check-skipped = get block template / Run get-block-template test
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Check if cached state disks exist for Mainnet / Check if cached state disks exist
    • check-neutral = Check if cached state disks exist for Mainnet / Check if cached state disks exist
    • check-skipped = Check if cached state disks exist for Mainnet / Check if cached state disks exist
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Test integration with lightwalletd
    • check-neutral = Test integration with lightwalletd
    • check-skipped = Test integration with lightwalletd
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = lightwalletd GRPC tests / Run lwd-grpc-wallet test
    • check-neutral = lightwalletd GRPC tests / Run lwd-grpc-wallet test
    • check-skipped = lightwalletd GRPC tests / Run lwd-grpc-wallet test
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = lightwalletd tip send / Run lwd-send-transactions test
    • check-neutral = lightwalletd tip send / Run lwd-send-transactions test
    • check-skipped = lightwalletd tip send / Run lwd-send-transactions test
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = lightwalletd tip update / Run lwd-update-sync test
    • check-neutral = lightwalletd tip update / Run lwd-update-sync test
    • check-skipped = lightwalletd tip update / Run lwd-update-sync test
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Test CD custom Docker config file / Test custom-conf in Docker
    • check-neutral = Test CD custom Docker config file / Test custom-conf in Docker
    • check-skipped = Test CD custom Docker config file / Test custom-conf in Docker
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Test CD default Docker config file / Test default-conf in Docker
    • check-neutral = Test CD default Docker config file / Test default-conf in Docker
    • check-skipped = Test CD default Docker config file / Test default-conf in Docker
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Test CI custom Docker config file / Test custom-conf in Docker
    • check-neutral = Test CI custom Docker config file / Test custom-conf in Docker
    • check-skipped = Test CI custom Docker config file / Test custom-conf in Docker
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Test CI default Docker config file / Test default-conf in Docker
    • check-neutral = Test CI default Docker config file / Test default-conf in Docker
    • check-skipped = Test CI default Docker config file / Test default-conf in Docker
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Test stable on macos-latest
    • check-neutral = Test stable on macos-latest
    • check-skipped = Test stable on macos-latest
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Build and Deploy Zebra Book Docs
    • check-neutral = Build and Deploy Zebra Book Docs
    • check-skipped = Build and Deploy Zebra Book Docs
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Build and Deploy Zebra Internal Docs
    • check-neutral = Build and Deploy Zebra Internal Docs
    • check-skipped = Build and Deploy Zebra Internal Docs
  • any of [🛡 GitHub repository ruleset rule]:
    • check-success = Check crate release dry run
    • check-neutral = Check crate release dry run
    • check-skipped = Check crate release dry run

Check-runs and statuses of the embarked pull request #8972:

Build CI Docker / Build images details
Clippy details
Open or update issues for release crates failures details
Rustfmt details
Test CI testnet Docker config file / Test default-conf in Docker details
actionlint details
Build CD Docker / Build images details
Build and Deploy Zebra Book Docs details
Build and Deploy Zebra Internal Docs details
Build tower-batch-control crate details
Build tower-fallback crate details
Build zebra-chain crate details
Build zebra-consensus crate details
Build zebra-grpc crate details
Build zebra-network crate details
Build zebra-node-services crate details
Build zebra-rpc crate details
Build zebra-scan crate details
Build zebra-script crate details
Build zebra-state crate details
Build zebra-test crate details
Build zebra-utils crate details
Build zebrad crate details
Check Cargo.lock is up to date details
Check crate release dry run details
Check crates matrix details
Check deny.toml bans details
Check deny.toml bans --all-features details
Check deny.toml bans --features default-release-binaries details
Check deny.toml sources details
Check deny.toml sources --all-features details
Check deny.toml sources --features default-release-binaries details
Check for unused dependencies details
Check if cached state disks exist for Mainnet / Check if cached state disks exist details
Checks changed-files details
Coverage on stable details
Generate checkpoints mainnet / Run checkpoints-mainnet test details
Generate crates matrix details
Install zebrad from lockfile without cache on ubuntu-latest details
Test CD custom Docker config file / Test custom-conf in Docker details
Test CD default Docker config file / Test default-conf in Docker details
Test CD testnet Docker config file / Test default-conf in Docker details
Test CI custom Docker config file / Test custom-conf in Docker details
Test CI default Docker config file / Test default-conf in Docker details
Test all details
Test beta on ubuntu-latest details
Test beta on windows-latest details
Test checkpoint sync from empty state details
Test integration with lightwalletd details
Test stable on macos-latest details
Test stable on ubuntu-latest details
Test stable on windows-latest details
Test with fake activation heights details
Zebra checkpoint update / Run sync-past-checkpoint test details
Zebra tip JSON-RPC / Run fully-synced-rpc test details
Zebra tip update / Run update-to-tip test details
codespell details
get block template / Run get-block-template test details
lightwalletd GRPC tests / Run lwd-grpc-wallet test details
lightwalletd tip / Run lwd-full-sync test details
lightwalletd tip send / Run lwd-send-transactions test details
lightwalletd tip update / Run lwd-update-sync test details
mergefreeze Ok to mergedetails
submit block / Run submit-block test details
update_release_draft details