docs(env): Document the HORIZON_* resilience tuning variables in the environment reference

Open Beginner friendly
#673 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
rust
Domain
documentation

Research direction

Read ResilienceConfig::from_env to confirm each variable’s default and purpose, then follow the existing table and example patterns in docs/environment-variables.md and .env.example. Add one documented row and a commented example for each variable, marking each as non-secret. Run just check-env-docs; done when it passes and all five variables appear in both files.

Written by the indexing model from the issue text.

Description

area/integration documentation good first issue help wanted

Description

ResilienceConfig::from_env reads HORIZON_MAX_ATTEMPTS, HORIZON_BASE_DELAY_MS, HORIZON_MAX_DELAY_MS, HORIZON_CB_FAILURE_THRESHOLD and HORIZON_CB_RESET_TIMEOUT_SECS, but none appear in docs/environment-variables.md or .env.example.

Requirements and context

  • Where: docs/environment-variables.md, .env.example
  • Security: Follow docs/threat-model.md; no secrets, tokens or personal data in code, logs, tests or commit messages.
  • Testing: just fmt-check, just lint and just test must pass; add or update tests for the change.
  • Documentation: Update the nearest doc if behaviour changes; otherwise no doc change is needed.

Suggested execution

  • Comment on this issue to claim it, then fork the repository and branch from main.
  • Branch name: git checkout -b docs/env-horizon-resilience-vars

Implement changes

  • Add a row per variable with default, purpose and secret=no.
  • Add commented examples to .env.example.
  • Run just check-env-docs.

Test and commit

  • just check-env-docs passes (see the scanner fix issue if it does not cover this crate).
  • Run just fmt, just lint and just test locally before pushing (see CONTRIBUTING.md).
  • Commit with a conventional message and keep the change small and focused.

Example commit message

docs(env): document horizon resilience variables

Guidelines

  • Open the PR against main and link it with Closes #<this issue>.
  • Keep the diff focused on this issue; no unrelated refactors or formatting churn.
  • One line per comment, no bloated code; follow patterns already used in the crate.
  • Never commit secrets, .env files or real keys; use public test vectors only.
  • CI (fmt, clippy -D warnings, tests) must be green before requesting review.
  • Ask in the issue thread if anything is unclear before starting.
Dominant language
Rust
Stars
0
Forks
91
Avg merge
5h 23m
Merged PRs (30d)
4

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Octo-Protocol-org/Octo-Protocol

All issues in Octo-Protocol-org/Octo-Protocol

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.