docs(onboarding): Author the missing README for the horizon-mock workspace member

Open Beginner friendly
#667 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
markdown, rust
Domain
documentation

Research direction

Read the crate description in crates/horizon-mock/Cargo.toml and inspect the existing READMEs for api, store, ingest and webhooks. Create crates/horizon-mock/README.md under 40 lines describing what the mock serves and how to run it with HORIZON_MOCK_ADDR and HORIZON_MOCK_FIXTURES, with a link to the relevant file under docs/. Done when the README covers those points and its documented command has been run.

Written by the indexing model from the issue text.

Description

area/integration documentation good first issue help wanted

Description

crates/horizon-mock has no README, unlike api, store, ingest and webhooks, so newcomers cannot tell what it is for.

Requirements and context

  • Where: crates/horizon-mock/README.md
  • 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/horizon-mock-readme

Implement changes

  • Create a short README (under 40 lines) covering how to run the offline mock (HORIZON_MOCK_ADDR, HORIZON_MOCK_FIXTURES) and what it serves.
  • Copy the one-line description from the crate's Cargo.toml.
  • Link the relevant file under docs/.

Test and commit

  • Preview the Markdown and run any command you document.
  • 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(horizon-mock): add README

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.