Skip to content

docs: add pipelines documentation and CLI usage#14

Open
samcday wants to merge 62 commits into
gibblox-schemafrom
codex/github-mention-pipelines
Open

docs: add pipelines documentation and CLI usage#14
samcday wants to merge 62 commits into
gibblox-schemafrom
codex/github-mention-pipelines

Conversation

@samcday

@samcday samcday commented Feb 25, 2026

Copy link
Copy Markdown
Owner

Motivation

  • Provide user-facing documentation for the new pipeline descriptor model so readers can understand, author, and operate pipelines (leafs/wrappers/selectors, YAML shape, and common patterns).
  • Surface CLI workflows and examples to make gibblox-cli pipeline actions (validate, encode, decode, and direct execution) discoverable and easy to follow.

Description

  • Add docs/pipelines.md containing a conceptual overview, YAML examples (HTTP, local file + GPT, casync with/without chunk_store), and gibblox-cli usage examples.
  • Update README.md with a new Pipelines section that links to the detailed guide in docs/pipelines.md.
  • This is documentation-only and does not change runtime behavior or public APIs.

Testing

  • Ran cargo check -p gibblox-cli, which completed successfully.
  • No additional automated tests were added because the changes are documentation-only.

Codex Task

Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
@samcday

samcday commented Feb 25, 2026

Copy link
Copy Markdown
Owner Author

@codex rebase and update this PR

@chatgpt-codex-connector

Copy link
Copy Markdown

Summary

  • Followed up on the docs PR with a new commit that clarifies pipeline validation behavior for YAML vs binary descriptors in the top-level README pipelines section. README.mdL61-L67
  • Updated the detailed pipelines guide to explicitly include both pipeline validate (YAML) and pipeline validate --binary examples in the CLI workflow section. docs/pipelines.mdL66-L92
  • Clarified the notes section so validate default behavior and --binary behavior are both stated directly. docs/pipelines.mdL108-L113
  • Created a follow-up PR entry via make_pr after committing (ef60413), per your instruction.

Testing

  • cargo check -p gibblox-cli
  • git rebase 0939c9b457daeef4d6a14ca7a268ffe93ea82515 (failed: base SHA from PR metadata is not present in this local clone, so a true rebase onto that exact commit could not be executed here)
  • ⚠️ curl -L -s 'https://duckduckgo.com/html/?q=git%20rebase%20pull%20request%20branch%20onto%20latest%20base' | head -n 5 (search endpoint returned no visible content in this environment)
  • ⚠️ curl -L -s 'https://www.bing.com/search?q=git+rebase+pull+request+branch+onto+latest+base' | head -n 5 (search endpoint returned no visible content in this environment)

View task →

GibbloxBot and others added 17 commits February 25, 2026 22:13
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Drop the unused greedy prefetch layer and its visualizer harness so cache stays simpler and we avoid pulling newer futures-channel churn into the workspace.

Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
@samcday samcday force-pushed the codex/github-mention-pipelines branch from 685a85a to 20dad24 Compare February 26, 2026 00:49
GibbloxBot and others added 29 commits February 26, 2026 15:05
Switch the Intel macOS binary matrix entry off macos-13 so the release workflow uses a supported runner configuration.

Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Run the CLI binary matrix for release/v* pushes and switch upload-rust-binary-action to dry-run in branch mode so target and runner issues are caught before creating a release tag.

Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
…apter

Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Rename HTTP/file/web-file/ext4 file reader types and configs from *BlockReader to *Reader to match their primary ByteReader role. Update downstream call sites and docs to the new API names.

Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Add a fast path in AlignedByteReader that reads block-aligned requests directly into the caller buffer instead of allocating an intermediate Vec and copying. Add a regression test that verifies aligned reads pass the caller buffer through to the BlockReader.

Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Treat CLI --blocksize as output shaping only so upstream readers keep source-appropriate block sizes. Retry in-range file reads until complete to avoid short-read truncation.

Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Use is_multiple_of in aligned byte reads and drop needless borrows in GPT partition table handling so workspace CI runs clean.

Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
Signed-off-by: Sam Day <me@samcday.com>
Assisted-by: opencode:gpt-5.3-codex
@samcday samcday force-pushed the codex/github-mention-pipelines branch from 20dad24 to deb97db Compare February 27, 2026 07:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant