Skip to content

docs(readme): rename Slopsmith to feedBack and document FEEDBACK_PLUGINS_DIR - #85

Open
odntht wants to merge 1 commit into
got-feedBack:mainfrom
odntht:docs/feedback-naming
Open

odntht wants to merge 1 commit into
got-feedBack:mainfrom
odntht:docs/feedback-naming

Conversation

@odntht

@odntht odntht commented Oct 16, 2026

Copy link
Copy Markdown

What was wrong

The README still called the host "Slopsmith" all the way through (title, install comment, host APIs, desktop sections, Requirements, Develop locally). The dev section also presented SLOPSMITH_PLUGINS_DIR as the only way to mount user plugins.

What changed

  • Product name: prose now says feedBack, feedBack core and feedBack Desktop, and slopsmith-desktop/src/audio/MlNoteDetector.* is now feedBack-desktop/src/audio/MlNoteDetector.*. That path exists on feedBack-desktop main.
  • Plugins dir env var: the Develop locally section says core reads FEEDBACK_PLUGINS_DIR first and still accepts SLOPSMITH_PLUGINS_DIR, which is the name the overlay sets. Core plugins/__init__.py:1170 has os.environ.get("FEEDBACK_PLUGINS_DIR") or os.environ.get("SLOPSMITH_PLUGINS_DIR").
  • Identifiers kept on purpose, because they're still real:
    • window.slopsmith: the plugin emits on it (screen.js window.slopsmith.emit), and core still aliases it (static/app.js:336 window.slopsmith = window.feedBack). The README now says it's the legacy alias.
    • SLOPSMITH_DIR and SLOPSMITH_PORT: Makefile and .env.example variables.
    • the docker-compose.slopsmith.yml file name.
    • historical refs like slopsmith#254, slopsmith#818 and slopsmith@b65a08c.

Verification

  • The grep that remains for "slopsmith" in README.md only hits the identifiers and historical refs listed above.
  • The env var behavior was checked against got-feedBack/feedBack main.

Docs only. Overlap notes:

🤖 Generated with Claude Code

…INS_DIR

Rename the product from Slopsmith to feedBack in README prose, and
document that core reads FEEDBACK_PLUGINS_DIR first while still
accepting the SLOPSMITH_PLUGINS_DIR name the dev overlay sets
(feedBack plugins/__init__.py). Real identifiers are kept as they are:
window.slopsmith (still aliased by core app.js), the Makefile's
SLOPSMITH_DIR / SLOPSMITH_PORT, docker-compose.slopsmith.yml, and
historical slopsmith#NNN refs.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: odntht <odntht@gmail.com>
@coderabbitai

coderabbitai Bot commented Oct 16, 2026

Copy link
Copy Markdown
Contributor

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 3e676558-0371-4a0d-8395-21e971964780
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

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