26140117056
92%

Ran 20 May 2026 03:52AM UTC

Jobs 1

Files 128

Run time 1min

Badge

Embed ▾

Committed 20 May 2026 03:50AM UTC coverage: 92.141%. Remained the same

Build # 26140117056

Build Type

push

github

Committed by

web-flow

Commit Message

docs: consolidate docs index — prelude section + slim Contract Builder duplicate (#597)

Resolves v3-api-ergonomics.md \xc2\xa76 'Consolidate the docs index'. The
discoverability gap: `docs/api-patterns.md` and `docs/contract-builder.md`
both had Quick-Start-style code samples, and neither file mentioned the
prelude as the canonical front door.

- Add `## Prelude` section to api-patterns.md at the top, calling out
  `use ibapi::prelude::*;` as the canonical front door, pointing to the
  `src/prelude.rs` rustdoc (which has the full re-export list and the
  BarSize/WhatToShow disambiguation note shipped in #595), and noting the
  blocking-client path when both features are enabled.
- Slim the `### Contract Builder` subsection: 37 lines of duplicate code
  samples down to a 2-line intro + 2-line minimal example + a hard pointer
  to docs/contract-builder.md as the canonical home for per-asset-type
  reference.
- Drop stale `V2` qualifiers from the opening prose of api-patterns.md
  and contract-builder.md — there's no live v1/v2 split today; the API is
  just the API. The v1\xe2\x86\x92v2 historical migration section in
  contract-builder.md kept as-is (out of scope; still useful to v1 users).

Coverage Stats

18994 of 20614 relevant lines covered (92.14%)

27.54 hits per line

Jobs

ID	Job ID	Ran	Files	Coverage
1	26140117056.1	20 May 2026 03:52AM UTC	128	92.14	GitHub Action Run

wboayue / rust-ibapi / 26140117056
92%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 26140117056

wboayue / rust-ibapi / 26140117056 92%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 26140117056

wboayue / rust-ibapi / 26140117056
92%

README BADGES
x