Skip to content

docs: regenerate README to pick up buckets migrate and ls --source#90

Merged
designcode merged 1 commit intomainfrom
docs/regenerate-readme
Apr 23, 2026
Merged

docs: regenerate README to pick up buckets migrate and ls --source#90
designcode merged 1 commit intomainfrom
docs/regenerate-readme

Conversation

@designcode
Copy link
Copy Markdown
Collaborator

@designcode designcode commented Apr 23, 2026

Summary

  • Regenerated README.md from src/specs.yaml via npm run updatedocs, then ran npm run format.
  • Picks up two items that were added to the spec but never propagated to the README:

Most of the diff is formatting churn from the generator output (un-padded tables, no blank line before code fences) vs. the previous hand-formatted README — prettier leaves the generator output as-is, so the repo and generator had drifted stylistically.

Test plan

  • Spot-check the buckets migrate section renders correctly on GitHub
  • Confirm --source flag row shows up under tigris ls

Note

Low Risk
Low risk: documentation-only updates with substantial formatting churn but no code/runtime behavior changes.

Overview
Updates README.md generated CLI docs to include the missing tigris buckets migrate command and the --source flag on listing commands (notably ls/objects list).

The rest of the diff is largely formatting regeneration (table formatting and markdown layout) to align the README with the current docs generator output.

Reviewed by Cursor Bugbot for commit b38ec4c. Bugbot is set up for automated code reviews on this repo. Configure here.

Picks up the `buckets migrate` command and `ls --source` flag that
were added to specs.yaml but never propagated to README.md.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@designcode designcode merged commit d25afca into main Apr 23, 2026
3 checks passed
@designcode designcode deleted the docs/regenerate-readme branch April 23, 2026 11:00
@github-actions
Copy link
Copy Markdown

🎉 This PR is included in version 2.18.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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.

2 participants