Skip to content

docs: expand API guide for end users - #5

Merged
forhappy merged 1 commit into
mainfrom
codex/api-docs
Aug 18, 2026
Merged

docs: expand API guide for end users#5
forhappy merged 1 commit into
mainfrom
codex/api-docs

Conversation

@forhappy

Copy link
Copy Markdown
Contributor

Summary

  • Rework API.md into a task-oriented guide for end users.
  • Explain client setup, repository and snapshot concepts, branches and commits, object reads and writes, pagination, atomic multi-object publishing, history, merging, backup, integrity checks, garbage collection, indexes, caching, metrics, errors, retries, and canonical limits.
  • Add copy/paste-oriented Rust examples and operational guidance for recovery, resumable work, and external transfer managers.
  • Keep the documentation aligned with the current SILO client API and runnable examples.

Validation

  • cargo check --locked -p silo-s3-client --examples
  • cargo test --locked -p silo-s3-client --lib
  • git diff --check

This is opened as a draft for review.

@forhappy
forhappy marked this pull request as ready for review August 18, 2026 03:50
@forhappy
forhappy merged commit 1f7c8b0 into main Aug 18, 2026
3 checks passed
@forhappy
forhappy deleted the codex/api-docs branch August 18, 2026 03:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant