From ff8925015d58469a67326f7b0f885ab2f11e189e Mon Sep 17 00:00:00 2001 From: Matt Brictson Date: Mon, 18 Dec 2023 11:44:21 -0800 Subject: [PATCH] Replace [!NOTE] with less-shouty [!TIP] in READMEs --- README.md | 4 ++-- lib/nextgen/actions.rb | 2 +- template/README.md.tt | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5719a6c..c6fa6a4 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ gem exec nextgen create myapp This will download the latest version of the `nextgen` gem and use it to create an app in the `myapp` directory. You'll be asked to configure the tech stack through several interactive prompts. If you have a `~/.railsrc` file, it will be ignored. -> [!NOTE] +> [!TIP] > If you get an "Unknown command exec" error, fix it by upgrading rubygems: `gem update --system`. ## Examples @@ -58,7 +58,7 @@ Check out the [examples directory](./examples) to see some Rails apps that were On top of that foundation, Nextgen offers dozens of useful enhancements to the vanilla Rails experience. You are free to pick and choose which (if any) of these to apply to your new project. Behind the scenes, **each enhancement is applied in a separate git commit,** so that you can later see what was applied and why, and revert the suggestions if necessary. -> [!NOTE] +> [!TIP] > For the full list of what Nextgen provides, check out [config/generators.yml](https://github.com/mattbrictson/nextgen/tree/main/config/generators.yml). The source code of each generator can be found in [lib/nextgen/generators](https://github.com/mattbrictson/nextgen/tree/main/lib/nextgen/generators). Here are some highlights of what Nextgen brings to the table: diff --git a/lib/nextgen/actions.rb b/lib/nextgen/actions.rb index 15d658e..06bc198 100644 --- a/lib/nextgen/actions.rb +++ b/lib/nextgen/actions.rb @@ -95,7 +95,7 @@ def add_lint_task(task, fix: "#{task}:autocorrect") inject_into_file "README.md", " and lint checks", after: "automated tests" inject_into_file "README.md", <<~MARKDOWN, after: "```\nbin/rake\n```\n" - > [!NOTE] + > [!TIP] > Rake allows you to run all checks in parallel with the `-m` option. This is much faster, but since the output is interleaved, it may be harder to read. ``` diff --git a/template/README.md.tt b/template/README.md.tt index adafce0..e74bc85 100644 --- a/template/README.md.tt +++ b/template/README.md.tt @@ -30,7 +30,7 @@ Run this script to install necessary dependencies and prepare the Rails app to b bin/setup ``` -> [!NOTE] +> [!TIP] > The `bin/setup` script is idempotent and is designed to be run often. You should run it every time you pull code that introduces new dependencies or makes other significant changes to the project. ### Run the app!