Repository navigation
docs: unify template instructions around the plugin contract - #18
Merged
Merged
Conversation
Make AGENTS.md the authoritative development guide: it now names the spec and Host repositories with the pinned revisions this template was verified against, separates normative spec rules from observed Host behavior (folder/id handling and the screen-mount gate), adds a copy/rename checklist, and states exact setup commands plus completion criteria. CLAUDE.md no longer carries corrections to AGENTS.md; it defers to it. The READMEs drop the unsupported "folder/id mismatch will not load" claim, name the Host's real plugin-discovery directories, and state the settings store as <config_dir>/<id>.json. Spec links use the canonical get-flashbacks/feedBack-plugin-spec name.
6 tasks
cchacs
self-requested a review
October 17, 2026 03:51
Code Review SummaryStatus: No Issues Found | Recommendation: Merge Files Reviewed (6 files)
Reviewed by efficient · Input: 99.7K · Output: 18.4K · Cached: 338.8K |
cchacs
approved these changes
Oct 17, 2026
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
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
Closes #15. Makes
AGENTS.mdthe single authoritative development guide and removes the contradictory corrections that lived inCLAUDE.md, so an agent following any one guide reaches the same decisions.What changed
AGENTS.md(now authoritative) — adds and owns the load-bearing contract facts:get-flashbacks/feedBack-plugin-spec) and Host repo (get-flashbacks/feedBack), each pinned to a reproducible revision (3d653d1,ff8984a) with links and a copy-paste verification command.id(§5.2/§4.2), while the shipped Host registers by manifestidregardless of folder name (folder name only feeds_is_bundled()for duplicate resolution);plugin-<id>screen container is Host-gated onbool(manifest.get("screen"))and the fetch path is hardcoded toscreen.html.pip install -r requirements-dev.txt+pytest -q), thecustom-checks.ymlsteps, and the running-Host smoke checks.CLAUDE.md— drops the "two corrections toAGENTS.md" section and defers toAGENTS.md; keeps the template-vs-plugin context and canonical repo links (casing fixed tofeedBack-plugin-spec).READMEs — the folder/id section no longer claims a mismatch "will not load" (it now distinguishes the spec requirement from Host leniency); the plugin-discovery directories are stated per spec §5.1 (
plugins/,FEEDBACK_PLUGINS_DIR, Plugin Manager); settings storage is stated as<config_dir>/<id>.json; spec links canonicalized..gitignore/CHANGELOG.md— ignore the.venv/the documented setup creates; changelog entry added.Verification
pytest -q→ 21 passed.node --check my-plugin/screen.js→ OK.custom-checks.ymlmanifest validation → OK; noprint(inroutes.py.Docs-only change, so no behavioral surface to review beyond the accuracy of the cited contract claims.
big-pickle(free) | 𝕏