diff --git a/lib/generators/suspenders/accessibility_generator.rb b/lib/generators/suspenders/accessibility_generator.rb index 003ac817d..70ccaf889 100644 --- a/lib/generators/suspenders/accessibility_generator.rb +++ b/lib/generators/suspenders/accessibility_generator.rb @@ -4,7 +4,11 @@ class AccessibilityGenerator < Rails::Generators::Base include Suspenders::Generators::APIAppUnsupported desc <<~MARKDOWN - Installs capybara_accessibility_audit and capybara_accessible_selectors" + Uses [capybara_accessibility_audit][] and [capybara_accessible_selectors][] to + encourage and enforce accessibility best practices. + + [capybara_accessibility_audit]: https://github.com/thoughtbot/capybara_accessibility_audit + [capybara_accessible_selectors]: https://github.com/citizensadvice/capybara_accessible_selectors MARKDOWN def add_capybara_gems diff --git a/lib/generators/suspenders/advisories_generator.rb b/lib/generators/suspenders/advisories_generator.rb index 2d27fca50..e1da61bf5 100644 --- a/lib/generators/suspenders/advisories_generator.rb +++ b/lib/generators/suspenders/advisories_generator.rb @@ -3,10 +3,10 @@ module Generators class AdvisoriesGenerator < Rails::Generators::Base source_root File.expand_path("../../templates/advisories", __FILE__) desc <<~MARKDOWN - Show security advisories during development. - - Uses the `bundler-audit` gem to update the local security database and + Uses the [bundler-audit][] to update the local security database and show any relevant issues with the app's dependencies via a Rake task. + + [bundler-audit]: https://github.com/rubysec/bundler-audit MARKDOWN def add_bundler_audit diff --git a/lib/generators/suspenders/ci_generator.rb b/lib/generators/suspenders/ci_generator.rb index 4204b38d0..51e7d01b5 100644 --- a/lib/generators/suspenders/ci_generator.rb +++ b/lib/generators/suspenders/ci_generator.rb @@ -6,7 +6,10 @@ class CiGenerator < Rails::Generators::Base source_root File.expand_path("../../templates/ci", __FILE__) desc <<~MARKDOWN - Creates CI files for GitHub Actions + Uses [GitHub Actions][] for CI, and [Dependabot][] for dependency updates. + + [GitHub Actions]: https://docs.github.com/en/actions + [Dependabot]: https://docs.github.com/en/code-security/dependabot/working-with-dependabot MARKDOWN def ci_files diff --git a/lib/generators/suspenders/email_generator.rb b/lib/generators/suspenders/email_generator.rb index 7883b692a..f46536acc 100644 --- a/lib/generators/suspenders/email_generator.rb +++ b/lib/generators/suspenders/email_generator.rb @@ -3,13 +3,17 @@ module Generators class EmailGenerator < Rails::Generators::Base source_root File.expand_path("../../templates/email", __FILE__) desc <<~MARKDOWN - Intercepts emails in non-production environments by setting `INTERCEPTOR_ADDRESSES`. + [Intercept][] emails in non-production environments by setting `INTERCEPTOR_ADDRESSES`. ```sh INTERCEPTOR_ADDRESSES="user_1@example.com,user_2@example.com" bin/rails s ``` - Configures `default_url_options` in `test` and `development`. + Configuration can be found at `config/initializers/email_interceptor.rb`. + + Interceptor can be found at `app/mailers/email_interceptor.rb`. + + [Intercept]: https://guides.rubyonrails.org/action_mailer_basics.html#intercepting-emails MARKDOWN def create_email_interceptor