Docs: multi-platform README + rename Discord config to discord_config.yaml#60
Merged
Merged
Conversation
- README: rewrite as a proper intro covering Discord + Slack and the unified CLI; drop the unimplemented human-in-the-loop/admin-escalation claims. - CLAUDE.md: cover both platforms and the PydanticAI engine; align lint/test commands with CI; document the discord_config.yaml default. - Rename config.example.yaml -> discord_config.example.yaml (symmetry with slack_config.example.yaml); default Discord config is now discord_config.yaml. - Keep the old config.yaml working: resolve_discord_config_path() prefers discord_config.yaml and falls back to config.yaml with a deprecation warning. Add unit tests for the resolver. - .gitignore: keep config.yaml ignored and add discord_config.yaml / slack_config.yaml so secret-bearing configs can't be committed; ignore .codex-review/ artifacts. - Dockerfile: bump to python:3.13-slim and switch entrypoint to the unified CLI (ENTRYPOINT ["innieme"], CMD ["discord"]). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
Follow-up to the Slack-bot merge (#57): make the user-facing docs reflect that InnieMe now runs on both Discord and Slack, and rename the Discord config for symmetry with
slack_config.yaml.innieme discord|slackCLI. Dropped the human-in-the-loop / admin-escalation claims (that flow isn't working yet, so we're not advertising it).discord_config.yamldefault.config.example.yaml→discord_config.example.yaml; the default Discord config is nowdiscord_config.yaml.resolve_discord_config_path()prefersdiscord_config.yamlbut falls back to the legacyconfig.yamlwith a deprecation warning, so existing setups keep working. Unit tests cover prefer / fallback / default.config.yamlignored and addsdiscord_config.yaml/slack_config.yamlso secret-bearing configs can't be committed; ignores.codex-review/artifacts.python:3.13-slim(matchespyproject.toml/ CI) and a unified entrypoint (ENTRYPOINT ["innieme"],CMD ["discord"]) so the image can run either platform.Test plan
pytest— 34 passed (3 new resolver tests).Codex review
2 rounds. Round 1 (CHANGES_REQUESTED) raised two blocking issues, both addressed:
resolve_discord_config_path()with legacy fallback + tests.config.yamlfrom.gitignorecould leak secrets → kept it ignored and added the new config names explicitly.Round 2: PASS. A non-blocking note about a dangling README sentence was also fixed. (Nothing declined.)
🤖 Generated with Claude Code