docs: skills documentation, setup scripts, README polish (Tasks 9.4, 9.5, 9.6) #30
Conversation
…9.6) - Add docs/skills.md with comprehensive guide to creating custom skills - Add scripts/setup-butler.sh for butler CLI installation and login - Add scripts/setup-slack-app.sh for Slack app setup with required scopes - Polish README.md with badges, architecture diagram, improved structure Closes #29 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Summary of ChangesHello @PSthelyBlog, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on improving the project's onboarding experience and documentation. It introduces detailed guidance on how the AI agent uses "skills" for game development, automates the setup of crucial external tools like the itch.io Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly improves the project's documentation and developer experience. The README is now much more comprehensive, with clear sections for architecture, commands, and setup. The new docs/skills.md file provides excellent, in-depth documentation on how to use and create skills. The addition of setup scripts for butler and Slack is a great touch that will simplify onboarding for new users.
My review includes a few minor suggestions to improve the robustness of the setup scripts and the installation instructions in the README. Overall, this is a high-quality contribution that greatly enhances the project's usability and maintainability.
| # Install in development mode | ||
| pip install -e ".[dev]" | ||
| # Create virtual environment (Python 3.11+ required) | ||
| python3.11 -m venv .venv |
There was a problem hiding this comment.
The command python3.11 -m venv .venv is very specific and might fail if a user has Python 3.11+ installed under a different name (e.g., python or python3). It's more robust to use a generic command and rely on the user having a compliant Python version in their PATH, as mentioned in the requirements.
| python3.11 -m venv .venv | |
| python -m venv .venv |
| linux) | ||
| echo "linux-amd64" | ||
| ;; |
There was a problem hiding this comment.
The detect_platform function currently only supports the amd64 architecture for Linux. To improve compatibility, you should add support for arm64 (aarch64), which is common on devices like Raspberry Pi and some cloud servers. Butler provides builds for linux-arm64.
| linux) | |
| echo "linux-amd64" | |
| ;; | |
| linux) | |
| case "$arch" in | |
| arm64|aarch64) | |
| echo "linux-arm64" | |
| ;; | |
| *) | |
| echo "linux-amd64" | |
| ;; | |
| esac | |
| ;; |
| generate_manifest() { | ||
| local app_name="${1:-Game Workflow}" | ||
|
|
||
| cat << 'MANIFEST' | ||
| display_information: | ||
| name: Game Workflow | ||
| description: Automated game creation workflow with human approval gates | ||
| background_color: "#4A154B" | ||
| features: | ||
| bot_user: | ||
| display_name: Game Workflow | ||
| always_online: true | ||
| oauth_config: | ||
| scopes: | ||
| bot: | ||
| - chat:write | ||
| - chat:write.public | ||
| - reactions:read | ||
| - channels:history | ||
| - groups:history | ||
| - im:history | ||
| - mpim:history | ||
| settings: | ||
| org_deploy_enabled: false | ||
| socket_mode_enabled: false | ||
| token_rotation_enabled: false | ||
| MANIFEST | ||
| } |
There was a problem hiding this comment.
The app_name local variable is defined but not used within the generate_manifest function; the app name is hardcoded. This is misleading and limits the function's reusability. To fix this, you should use the app_name variable in the manifest. You'll also need to change cat << 'MANIFEST' to cat << MANIFEST to enable variable expansion.
generate_manifest() {
local app_name="${1:-Game Workflow}"
cat << MANIFEST
display_information:
name: ${app_name}
description: Automated game creation workflow with human approval gates
background_color: "#4A154B"
features:
bot_user:
display_name: ${app_name}
always_online: true
oauth_config:
scopes:
bot:
- chat:write
- chat:write.public
- reactions:read
- channels:history
- groups:history
- im:history
- mpim:history
settings:
org_deploy_enabled: false
socket_mode_enabled: false
token_rotation_enabled: false
MANIFEST
}
Summary
docs/skills.md)scripts/setup-butler.sh)scripts/setup-slack-app.sh)Changes
Task 9.4: Skills Documentation
Task 9.5: Setup Scripts
setup-butler.sh: Downloads and installs butler CLI, handles login with API keysetup-slack-app.sh: Interactive guide for creating Slack app with correct OAuth scopesTask 9.6: README Polish
Test Plan
Closes #29
🤖 Generated with Claude Code