Skip to content

docs!: remove obsolete spec and test matrix#207

Merged
overtrue merged 1 commit into
mainfrom
overtrue/remove-spec-test-matrix
May 18, 2026
Merged

docs!: remove obsolete spec and test matrix#207
overtrue merged 1 commit into
mainfrom
overtrue/remove-spec-test-matrix

Conversation

@overtrue
Copy link
Copy Markdown
Contributor

@overtrue overtrue commented May 18, 2026

Summary

  • Remove obsolete docs/SPEC.md and docs/TEST_MATRIX.md.
  • Add navigation between the root README and the generated rc command reference.

BREAKING

This removes the legacy CLI specification and test matrix documents. The maintained command documentation now lives under docs/reference/rc/README.md.

Validation

  • git diff --check
  • Cargo checks not run locally because this is a Markdown-only documentation change.

@overtrue overtrue changed the title docs: remove obsolete spec and test matrix docs!: remove obsolete spec and test matrix May 18, 2026
@overtrue overtrue force-pushed the overtrue/remove-spec-test-matrix branch from 0f877cc to 250cb98 Compare May 18, 2026 14:31
@overtrue overtrue marked this pull request as ready for review May 18, 2026 15:09
Copilot AI review requested due to automatic review settings May 18, 2026 15:09
@overtrue overtrue merged commit 0590295 into main May 18, 2026
15 checks passed
@overtrue overtrue deleted the overtrue/remove-spec-test-matrix branch May 18, 2026 15:09
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Documentation-only cleanup removing two obsolete docs and adding cross-links between the root README and the generated rc command reference.

Changes:

  • Delete obsolete docs/SPEC.md and docs/TEST_MATRIX.md.
  • Add a link from README.md to the rc command reference.
  • Add a reciprocal link from the rc reference back to the root README.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
README.md Adds pointer to full rc command reference.
docs/SPEC.md Removed; superseded by generated reference.
docs/TEST_MATRIX.md Removed; obsolete test matrix.
docs/reference/rc/README.md Adds back-link to project README.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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: 250cb98c26

ℹ️ About Codex in GitHub

Your team has set up Codex to 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 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/SPEC.md
Comment on lines -1 to -4
# rc CLI Specification v2

> **PROTECTED FILE**: Changes to this specification require the Breaking Change process.
> See AGENTS.md for the required workflow.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Keep the protected CLI contract reachable

In this repo, AGENTS.md still names docs/SPEC.md as the protected CLI behavior contract and directs future breaking changes to update relevant SPEC sections, but this commit deletes that file without updating the workflow or adding an equivalent protected replacement. When future CLI-contract changes follow the documented process, they now point to a non-existent authority, which makes compatibility review and migration tracking ambiguous despite the commit being marked breaking.

Useful? React with 👍 / 👎.

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