Skip to content

docs: deprecation notice — canon is SpectraSynq_K1_Firmware - #2

Open
synqing wants to merge 2 commits into
masterfrom
docs/deprecation-notice
Open

synqing wants to merge 2 commits into
masterfrom
docs/deprecation-notice

Conversation

@synqing

@synqing synqing commented Jul 20, 2026

Copy link
Copy Markdown
Owner

K1 firmware has been consolidated onto a single canonical repository, SpectraSynq_K1_Firmware (ratified 2026-07-21); this repo is retained as a greenfield simulation-first spike whose lessons are being harvested into canon before archival.

This PR is purely additive and reviewable: it prepends a deprecation banner to README.md and adds a new DEPRECATED.md — no existing content is modified or removed.

Made with Cursor

Summary by CodeRabbit

  • Documentation
    • Added prominent deprecation notices to the project documentation.
    • Identified the canonical K1 firmware repository as the single source of truth.
    • Clarified that this repository is retained as a simulation-first spike and will not receive new features.
    • Added guidance on where to find consolidation plans, migration work, and inventory details.

…mware canon

Co-authored-by: Cursor <cursoragent@cursor.com>
@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The repository documentation now identifies this project as deprecated and non-canonical, links to SpectraSynq_K1_Firmware as the K1 firmware source of truth, and states that no new features will be added.

Changes

Repository deprecation

Layer / File(s) Summary
Add deprecation notices
DEPRECATED.md, README.md
Adds deprecation messaging, canonical repository links, simulation-first status, archival intent, and a separator before the existing README content.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the deprecation notice and names the canonical SpectraSynq_K1_Firmware repository.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/deprecation-notice

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@synqing

synqing commented Jul 21, 2026

Copy link
Copy Markdown
Owner Author

Closing — part of the retracted consolidation rollout. The banner pointed to canon's docs/consolidation set, which has been retracted (PR #23 closed). Nothing was merged. Deprecation of this experiment can be re-done cleanly once the go-forward strategy is finalized.

@synqing synqing closed this Jul 21, 2026
@synqing synqing reopened this Jul 21, 2026
…solidation link)

Co-authored-by: Cursor <cursoragent@cursor.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@DEPRECATED.md`:
- Around line 3-15: Remove the premature deprecation content from DEPRECATED.md
lines 3-15, including the future-dated ratification, canonical-repository link,
archival policy, and consolidation-plan claims. Also remove or defer the
repeated deprecation banner in README.md lines 1-3 until the target repository
and policy are authoritative.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a8772eed-cf0d-41e1-9f92-5f758977e8ac

📥 Commits

Reviewing files that changed from the base of the PR and between 1f22fce and 6f4a8d5.

📒 Files selected for processing (2)
  • DEPRECATED.md
  • README.md

Comment thread DEPRECATED.md
Comment on lines +3 to +15
**Date:** 2026-07-22

The single source of truth for K1 firmware is now
**[SpectraSynq_K1_Firmware](https://github.com/synqing/SpectraSynq_K1_Firmware)**
(ratified 2026-07-21).

This repository is retained as a **greenfield simulation-first spike**. Its
lessons are being harvested into the canonical repository, after which this repo
will be archived. **No new features** will land here.

For the consolidation plan, the effect-migration backlog, and the working-copy
inventory, see the canon repository at
[SpectraSynq_K1_Firmware](https://github.com/synqing/SpectraSynq_K1_Firmware).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Do not publish the deprecation notices until the consolidation strategy is finalized. The current text directs readers to a retracted canonical target and announces a policy that the PR context says may be recreated later.

  • DEPRECATED.md#L3-L15: remove the future-dated ratification and canonical-repository claims until confirmed.
  • README.md#L1-L3: remove or defer the repeated banner until the final target and policy are authoritative.
📍 Affects 2 files
  • DEPRECATED.md#L3-L15 (this comment)
  • README.md#L1-L3
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@DEPRECATED.md` around lines 3 - 15, Remove the premature deprecation content
from DEPRECATED.md lines 3-15, including the future-dated ratification,
canonical-repository link, archival policy, and consolidation-plan claims. Also
remove or defer the repeated deprecation banner in README.md lines 1-3 until the
target repository and policy are authoritative.

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