Skip to content

docs(reference): add rc command reference#201

Merged
overtrue merged 31 commits into
mainfrom
codex/rc-reference-docs
May 15, 2026
Merged

docs(reference): add rc command reference#201
overtrue merged 31 commits into
mainfrom
codex/rc-reference-docs

Conversation

@cxymds
Copy link
Copy Markdown
Member

@cxymds cxymds commented May 14, 2026

Summary

  • Add an English docs/reference/rc/ command reference for all top-level rc operations.
  • Follow the MinIO mc reference style with Purpose, Syntax, Parameters, Examples, and Behavior sections while keeping content specific to rc.
  • Document preferred noun-first commands and legacy-compatible command forms for migration clarity.

Background

The project had CLI behavior documentation in docs/SPEC.md and examples in README.md, but did not have a MinIO-style operation reference for the supported rc command surface. This PR adds standalone user-facing reference pages without changing CLI contracts.

Solution

Each operation exposed by rc --help now has a Markdown page under docs/reference/rc/. The overview page links the command families and explains remote path format, output modes, and credential setup.

Test Status

  • Markdown-only documentation change; Rust compile/lint/test checks skipped per project docs exception.
  • Ran a Node verification script over 30 Markdown files to check:
    • no CJK text in reference docs
    • no TODO/TBD/FIXME placeholders
    • no MinIO RST :mc roles left behind
    • all local Markdown links resolve

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 9678e9b997

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread docs/reference/rc/mirror.md Outdated
Comment thread docs/reference/rc/cat.md Outdated
Comment thread docs/reference/rc/cp.md Outdated
@cxymds cxymds requested a review from overtrue May 15, 2026 03:38
@overtrue overtrue merged commit 9d24c62 into main May 15, 2026
29 of 30 checks passed
@overtrue overtrue deleted the codex/rc-reference-docs branch May 15, 2026 03:56
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.

2 participants