Repository navigation
docs: add an AI configuration assistant skill - #214
Open
aaron-congo wants to merge 9 commits into
Open
aaron-congo wants to merge 9 commits into
aaron-congo wants to merge 9 commits into
Conversation
sophia-bq
approved these changes
Oct 20, 2026
| 2. Explain the *minimum* set of choices that drove it (one or two sentences per non-trivial parameter). | ||
| 3. End with: *"Want me to walk through tradeoffs or show alternative configurations? Or shall I help you wire this into your code?"* | ||
| - **Match the user's style.** Don't over-explain to experts. Don't under-explain to novices. | ||
| - **Use placeholders for secrets.** Never echo real DB passwords, IAM tokens, AWS credentials, or KMS key ARNs a user pastes. Use `<password>`, `<secret-arn>`, `<your-kms-key-arn>`, etc. In Rails, suggest `<%= ENV['DB_PASSWORD'] %>` or Rails credentials rather than a literal password. |
Contributor
There was a problem hiding this comment.
Question for consistency should they have 'your-' at the start or no?
| ### 1.6 Hard rules | ||
|
|
||
| - Never invent plugin codes, parameter names, or default values not in this document. If a user asks about something unfamiliar, say *"I don't have that in my reference. Check the Ruby wrapper docs at `https://aws.github.io/aws-advanced-wrapper-docs/ruby/overview`."* | ||
| - **Plugin codes and parameter names are `snake_case`.** Plugin codes: `failover`, `gdb_failover`, `initial_connection`, `custom_endpoint`, `iam`, `secrets_manager`, `bg`, `kms_encryption`. That is the complete built-in list as of the version baseline at the end of this document. |
Contributor
There was a problem hiding this comment.
If possible can we keep the plugin list in only one place? We have this in plugin ordering for example
Comment on lines
+1094
to
+1096
| ### 8.3 Driver dialects | ||
|
|
||
| Chosen automatically from the entry point (`WrapperPgConnection` / `aws_postgresql` → `pg`; `WrapperMysql2Client` / `aws_mysql2` → `mysql2`). There is no parameter to set. |
Contributor
There was a problem hiding this comment.
What value does this add for the user?
| - §17 when a listed feature is added. | ||
| --> | ||
|
|
||
| # AWS Advanced Ruby Driver Wrapper - Configuration Assistant |
Contributor
There was a problem hiding this comment.
Is there value in adding a version of the quick start session https://github.com/aws/aws-advanced-go-wrapper/pull/611/changes#diff-6fba9c4156fbc64844843f256ed9e2936a097b790a63c412095d2edd54747b4bR53
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
2 participants
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
Add a self-contained AI configuration assistant skill for the Ruby wrapper
Description
Adds
docs/RUBY-WRAPPER-CONFIGURATION-ASSISTANT.md, a single markdown file users can load into an AI tool (Kiro and Claude Code skills, Cursor rules, Claude Projects, ChatGPT, Amazon Bedrock, or a plain chat) so it can:database.ymlentry or directWrapperPgConnection/WrapperMysql2Clientcode,The README gets a short "Configuring the Wrapper with AI Tools" section linking to it.
Scope and content
_sec), and dialect codes. It also covers what's specific to the Active Record adapters: whichdatabase.ymlkeys reach the driver, failover errors under Active Record,variables:, pool sizing, and multiple databases and roles.failover2maps tofailover, andfailoverTimeoutMsdivided by 1000 givesfailover_timeout_sec).How it was checked
aws_credentials_providerActive Record recipe in §6.4 was tested in a throwaway Rails app on Active Record 7.2, 8.0 and 8.1.Trying it
Copy the file into your AI tool's knowledge or rules, or paste it at the start of a chat. Then ask something like "Help me configure the AWS Advanced Ruby Driver Wrapper for my Rails app on Aurora PostgreSQL."
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.