docs: reconcile all docs with v1.5.3 product-outside-strix migration - #61
Merged
Merged
Conversation
Update UPGRADES.md, README.md, CONTRIBUTING.md, lyrashield/README.md, lyrashield/telemetry/README.md, and docs/*.mdx to reflect the post-PR-#58 state where all product behavior lives in lyrashield/** and strix/** is exact upstream v1.5.3 with only two generic seams. Key changes: - UPGRADES.md: add PR #58/#59/#60 ledger entries; update "Compatibility patches retained" and "LyraShield-owned contract" sections to reference lyrashield/** paths; add migration notes to historical sections (Parallel Search, Security hardening pass) with per-bullet "(Now ...)" annotations. - lyrashield/README.md: rewrite from "intentionally minimal" to full module map and registration-seam documentation. - lyrashield/telemetry/README.md: fix wrong claim that adapter rejects chatgpt/ subscription models (now supports by default). - docs/advanced/skills.mdx: document lyrashield/skills/ overlay directory. - docs/contributing.mdx: update gate description to v1.5.3 hard two-file allowlist; fix broken AI_AUDIT_REPORT.md reference. - docs/usage/cli.mdx: update viewer SPA path to lyrashield/interface/viewer/. - README.md, CONTRIBUTING.md: fix broken AI_AUDIT_REPORT.md references to link to UPGRADES.md security hardening section; update viewer path. - Remove stale planning/handoff docs (AI_AUDIT_REPORT.md, LYRASHIELD_DIFF_REPORT.md, MIGRATION_MATRIX.md, findings.md, progress.md, task_plan.md, upstream-sync-2e70402.md) superseded by UPGRADES.md. Verification: bash scripts/verify-controlled-derivative.sh -- 1011 passed, 1 skipped; lint/format/mypy/Bandit pass. Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
📝 WalkthroughWalkthroughThe pull request removes obsolete migration and audit documents. It updates the upgrade ledger and package documentation, documents immutable worker-image promotion, and aligns contribution, viewer, skill, provider, and security-hardening references with the LyraShield product boundary. ChangesDocumentation and release boundaries
Estimated code review effort: 2 (Simple) | ~15 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
lyrashield/README.md (1)
24-39: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winDistinguish modified seams from upstream hooks.
The introduction limits local
strix/**changes tostrix/config/loader.pyandstrix/skills/__init__.py. The list also namesstrix.agents.factory.register_tool_override,register_model_policy, andstrix.agents.prompt.FileSystemLoaderwithout stating that they remain exact-upstream APIs. Add that qualification so contributors do not treat those files as additional allowed edits.UPGRADES.mdalready makes this distinction.Proposed clarification
-Product modules register themselves through generic seams in the retained -`strix/**` substrate: +Product modules use generic upstream hooks and the two locally modified seams +in the retained `strix/**` substrate:🤖 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 `@lyrashield/README.md` around lines 24 - 39, Update the “Registration seams” section in README.md to distinguish locally modified seams from unchanged upstream hooks: explicitly state that only strix/config/loader.py and strix/skills/__init__.py are modified, while strix.agents.factory.register_tool_override, register_model_policy, and strix.agents.prompt.FileSystemLoader remain exact-upstream APIs and are not additional permitted edits.
🤖 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 `@docs/advanced/skills.mdx`:
- Line 145: Update the contribution guidance wording around the prohibition on
modifying strix/skills/** so it only forbids inherited skill files while
explicitly permitting the reviewed generic seam strix/skills/__init__.py,
keeping the override guidance for lyrashield/skills/ intact.
In `@UPGRADES.md`:
- Line 576: Update the historical note in UPGRADES.md to capitalize the proper
noun, using “Markdown table separator” instead of “markdown table separator,”
while preserving the surrounding sentence and formatting.
---
Nitpick comments:
In `@lyrashield/README.md`:
- Around line 24-39: Update the “Registration seams” section in README.md to
distinguish locally modified seams from unchanged upstream hooks: explicitly
state that only strix/config/loader.py and strix/skills/__init__.py are
modified, while strix.agents.factory.register_tool_override,
register_model_policy, and strix.agents.prompt.FileSystemLoader remain
exact-upstream APIs and are not additional permitted edits.
🪄 Autofix
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 Plus
Run ID: f14d20c4-b286-4fc6-8b82-da98053bb328
📒 Files selected for processing (19)
AI_AUDIT_REPORT.mdCONTRIBUTING.mdLYRASHIELD_DIFF_REPORT.mdMIGRATION_MATRIX.mdREADME.mdUPGRADES.mddocs/advanced/configuration.mdxdocs/advanced/skills.mdxdocs/cloud/overview.mdxdocs/contributing.mdxdocs/llm-providers/overview.mdxdocs/tools/sandbox.mdxdocs/usage/cli.mdxfindings.mdlyrashield/README.mdlyrashield/telemetry/README.mdprogress.mdtask_plan.mdupstream-sync-2e70402.md
💤 Files with no reviewable changes (6)
- upstream-sync-2e70402.md
- progress.md
- MIGRATION_MATRIX.md
- findings.md
- task_plan.md
- AI_AUDIT_REPORT.md
| Inherited skills live under `strix/skills/` (upstream v1.5.3 substrate). LyraShield additions and overrides live under `lyrashield/skills/` and are registered through the `register_skill_dir` seam in `strix/skills/__init__.py`. Any change must follow the same review boundary as other files: | ||
|
|
||
| - Keep the LyraShield modification banner on changed upstream skill files. | ||
| - Do not modify `strix/skills/**` directly; add or override skills in `lyrashield/skills/` instead. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
Clarify the strix/skills/** exception.
docs/contributing.mdx Line [13] allows strix/skills/__init__.py as a reviewed generic seam, but this rule forbids every path under strix/skills/**. Limit the prohibition to inherited skill files, or explicitly exempt strix/skills/__init__.py.
Proposed wording
-- Do not modify `strix/skills/**` directly; add or override skills in `lyrashield/skills/` instead.
+- Do not modify inherited skill files under `strix/skills/` directly; add or override skills in `lyrashield/skills/`. Keep `strix/skills/__init__.py` as the reviewed registration seam.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| - Do not modify `strix/skills/**` directly; add or override skills in `lyrashield/skills/` instead. | |
| - Do not modify inherited skill files under `strix/skills/` directly; add or override skills in `lyrashield/skills/`. Keep `strix/skills/__init__.py` as the reviewed registration seam. |
🤖 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 `@docs/advanced/skills.mdx` at line 145, Update the contribution guidance
wording around the prohibition on modifying strix/skills/** so it only forbids
inherited skill files while explicitly permitting the reviewed generic seam
strix/skills/__init__.py, keeping the override guidance for lyrashield/skills/
intact.
| - `README.md`: updated upstream base reference to v1.5.3. | ||
| - `UPGRADES.md`: replaced the Deep Review v12 footprint-budget blockquote with | ||
| a historical note clarifying the v1.5.3 hard gate supersedes it; fixed | ||
| markdown table separator and indentation formatting flagged by markdownlint. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Capitalize Markdown in the historical note.
Use Markdown table separator in this sentence. The proper noun is currently lowercase.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~576-~576: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...v1.5.3 hard gate supersedes it; fixed markdown table separator and indentation formatt...
(MARKDOWN_NNP)
🤖 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 `@UPGRADES.md` at line 576, Update the historical note in UPGRADES.md to
capitalize the proper noun, using “Markdown table separator” instead of
“markdown table separator,” while preserving the surrounding sentence and
formatting.
Source: Linters/SAST tools
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
lyrashield/**, andstrix/**is exact upstream v1.5.3 with only two generic seams.strix/**tolyrashield/**, and update the "Compatibility patches retained" and "LyraShield-owned contract" sections.lyrashield/README.mdfrom "intentionally minimal" to a full module map with registration-seam documentation.lyrashield/telemetry/README.md— adapter now supportschatgpt/subscription by default (was incorrectly saying it rejects them).docs/advanced/skills.mdxto document thelyrashield/skills/overlay directory.docs/contributing.mdxgate description to the v1.5.3 hard two-file allowlist.docs/usage/cli.mdxviewer SPA path tolyrashield/interface/viewer/.AI_AUDIT_REPORT.mdreferences in README.md, CONTRIBUTING.md, docs/contributing.mdx, and UPGRADES.md (file was deleted; now links to the UPGRADES.md security hardening section).AI_AUDIT_REPORT.md,LYRASHIELD_DIFF_REPORT.md,MIGRATION_MATRIX.md,findings.md,progress.md,task_plan.md,upstream-sync-2e70402.md.Test plan
bash scripts/verify-controlled-derivative.sh— 1011 passed, 1 skipped; lint/format/mypy/Bandit passstrix/**footprint unchanged (docs-only PR)Generated with Devin
Summary by CodeRabbit
New Features
Documentation