rails/guides/source
Will Mathewson 3ae8d7b863
Replace "here" link titles with meaningful titles
For accessibility reasons[1], it's recommended not to use "here"/"click
here"/"more" as the title for a link. When screen reader users are
tabbing through all links on the page, they'll miss the context of "read
more about X" preceding the "here". Thankfully, the sentences in the are
largely good to go, so the "here" can be dropped in favour of the last
part of the sentence to give the link title more meaning.

Some of these text changes may seem trivial, but when considering the
link text outwith its context sentences, the text has some more meaning
for those reading them through screen readers. (e.g. "API documentation"
-> "`number_to_currency` API documentation")

[1]: https://www.gov.uk/guidance/content-design/links#writing-link-text
2024-07-01 20:05:04 +01:00
..
epub Replaces mobi guide with epub for docs because of discontinued support 2022-08-05 00:18:20 +05:30
_license.html.erb
_welcome.html.erb Development of Rails 8.0 starts now 2024-05-13 16:45:20 +00:00
2_2_release_notes.md Fixes mime -> MIME 2022-10-02 07:10:43 +05:30
2_3_release_notes.md Capitalize "Rails" [ci-skip] 2023-12-19 13:16:47 -06:00
3_0_release_notes.md Fixed typo: HTML 5 -> HTML5 2022-02-21 02:34:46 +05:30
3_1_release_notes.md Use double quotes more consistenly in doc and error messages 2023-10-28 11:38:49 +02:00
3_2_release_notes.md [skip ci] Added missing $ for a bash script 2023-08-23 15:58:08 +05:30
4_0_release_notes.md Update 4_0_release_notes.md 2023-03-30 22:32:37 +02:00
4_1_release_notes.md Fix links to master branches renamed to main 2024-01-07 12:35:46 -05:00
4_2_release_notes.md Use double quotes more consistenly in doc and error messages 2023-10-28 11:38:49 +02:00
5_0_release_notes.md Fix the ActionRecord typo 2024-04-03 09:32:41 +02:00
5_1_release_notes.md [ci skip] Fixed typos and grammatical errors 2021-06-01 04:54:25 +05:30
5_2_release_notes.md Merge pull request #46174 from datt/fix-sqlite 2022-10-02 10:55:12 +02:00
6_0_release_notes.md [ci skip] Corrected Change logs to Changelogs 2021-05-31 18:40:12 +05:30
6_1_release_notes.md Lower case the link header 2024-05-31 21:00:22 +00:00
7_0_release_notes.md Ruby code block indentation issue fix 2023-09-07 01:14:48 +05:30
7_1_release_notes.md Add Highlights section in the Rails 7.1 release notes 2024-05-13 18:41:52 +00:00
7_2_release_notes.md Fix a value for disabling enqueue_after_transaction_commit [ci-skip] 2024-06-09 16:37:21 +09:00
8_0_release_notes.md Remove 7.2 release changes from Rails 8.0 release note 2024-05-15 08:45:49 +05:30
action_cable_overview.md Improve ActionCable redis config example [skip ci] 2024-04-08 00:30:19 +03:00
action_controller_overview.md Merge pull request #50785 from JunichiIto/add-note-to-params-hash 2024-06-04 14:52:10 +02:00
action_mailbox_basics.md [RF DOCS] Review Action Mailbox guide [ci-skip] (#50973) 2024-02-14 15:02:15 -03:00
action_mailer_basics.md Remove rollup and test machinery for rails-ujs (#50535) 2024-01-02 16:49:36 +01:00
action_text_overview.md Replace "here" link titles with meaningful titles 2024-07-01 20:05:04 +01:00
action_view_helpers.md Replace "here" link titles with meaningful titles 2024-07-01 20:05:04 +01:00
action_view_overview.md Replace "here" link titles with meaningful titles 2024-07-01 20:05:04 +01:00
active_job_basics.md Document what higher/lower priority numbers mean in ActiveJob guide 2024-05-24 22:12:06 +02:00
active_model_basics.md Replace "here" link titles with meaningful titles 2024-07-01 20:05:04 +01:00
active_record_basics.md Replace "here" link titles with meaningful titles 2024-07-01 20:05:04 +01:00
active_record_callbacks.md Replace "here" link titles with meaningful titles 2024-07-01 20:05:04 +01:00
active_record_composite_primary_keys.md Development of Rails 8.0 starts now 2024-05-13 16:45:20 +00:00
active_record_encryption.md [ci skip] doc: updated the default digest algorithm used for key derivation in ActiveRecord Encryption to SHA256. 2024-04-11 10:34:14 +09:00
active_record_migrations.md Replace "here" link titles with meaningful titles 2024-07-01 20:05:04 +01:00
active_record_multiple_databases.md Copy-edit pass on the multiple databases guide 2024-06-03 14:05:03 +02:00
active_record_postgresql.md Fix a typo in Active Record and PostgreSQL guide 2024-06-03 15:16:30 +03:00
active_record_querying.md Update active_record_querying.md 2024-04-05 23:59:53 +02:00
active_record_validations.md Add some description for MariaDB in ActiveRecord documentation 2024-03-14 15:33:12 -07:00
active_storage_overview.md fix the direct upload class example 2024-05-23 11:54:46 -05:00
active_support_core_extensions.md Add #weeks_since in active_support_core_extensions.md guide [ci skip] 2024-03-15 23:41:34 +09:00
active_support_instrumentation.md Define the new start_transaction.active_record event 2024-06-10 17:30:37 +02:00
api_app.md Update api_app.md to remove specific app name 2024-01-05 13:34:18 -05:00
api_documentation_guidelines.md Merge pull request #50593 from p8/guides/add-english-and-oxford-comma-to-wording 2024-01-08 19:04:47 +01:00
asset_pipeline.md Properly escape paths in erb example code blocks in guides [ci-skip] 2024-04-09 16:05:02 +02:00
association_basics.md Update association_basics.md 2024-06-05 04:55:01 +03:30
autoloading_and_reloading_constants.md Revise the autoloading guide for middleware and friends 2024-05-07 06:25:02 -04:00
caching_with_rails.md Doc: update partial rendering with dots in name 2024-01-30 09:32:41 +09:00
command_line.md Make devcontainer opt-in when creating a new application 2024-05-23 18:43:19 +00:00
configuring.md Add a config for preserving timezone information 2024-06-13 14:56:40 -07:00
contributing_to_ruby_on_rails.md Clarify contributing doc to not ping maintainers 2024-05-16 09:10:58 -04:00
debugging_rails_applications.md Development of Rails 8.0 starts now 2024-05-13 16:45:20 +00:00
development_dependencies_install.md Remove deprecated problem from local dev guide 2024-05-14 14:35:18 +00:00
documents.yaml Remove "Migrating from Classic to Zeitwerk" guide [ci-skip] 2024-06-19 15:27:17 +02:00
engines.md Move load hooks section to the configuration guide 2024-03-07 22:03:04 +00:00
error_reporting.md Use "library.name" format in initializer examples 2023-05-07 18:11:16 -04:00
form_helpers.md [RF-DOCS] Action View Form Helpers Guide [ci-skip] (#51936) 2024-06-28 17:49:36 +02:00
generators.md Capitalize "Rails" [ci-skip] 2023-12-19 13:16:47 -06:00
getting_started_with_devcontainer.md Fix broken links in Dev Containers start guide 2024-06-29 20:31:18 +09:00
getting_started.md Update getting_started.md 2024-06-26 02:58:17 -04:00
i18n.md Update link to i18n gem repository [ci-skip] 2024-05-15 14:59:27 +02:00
index.html.erb Guides Dark Mode fixes (#51444) 2024-03-30 19:09:38 +01:00
initialization.md Add rubocop-md for linting guides snippets 2023-03-15 10:48:19 +09:00
layout.html.erb Improve RTL Rendering for Guides (#51613) 2024-06-07 14:00:52 -03:00
layouts_and_rendering.md Mention yield :head in Guides 2024-06-14 11:16:39 +02:00
maintenance_policy.md Development of Rails 8.0 starts now 2024-05-13 16:45:20 +00:00
plugins.md Update link for creating a gem 2024-01-07 12:38:55 -05:00
rails_application_templates.md Add more gem docs in Rails Application Templates guide 2024-04-25 17:43:49 +08:00
rails_on_rack.md Update Rack::Head documentation to match code behavior 2023-12-12 21:08:56 +00:00
routing.md Fix typo / missing quote in routing guide [ci skip] 2024-03-13 11:02:15 -03:00
ruby_on_rails_guides_guidelines.md Fix broken anchor in Rails Guides Guidelines 2024-01-30 11:01:56 -03:00
security.md fix: outdated cors initializer docs 2024-02-10 13:30:00 -03:00
testing.md Document test transactions w/ multiple databases 2024-06-15 13:44:59 +02:00
threading_and_code_execution.md Capitalize headings to match style guidelines 2022-10-17 17:01:28 -10:00
tuning_performance_for_deployment.md Merge pull request #51976 from robin850/nitpicks-tuning-perf-guide 2024-05-31 17:16:38 -04:00
upgrading_ruby_on_rails.md Update the upgrade guides for Rails 7.1 regarding the breaking change (in development/test environments) of the location of secret_key_base (#52083) 2024-06-12 13:15:02 -07:00
working_with_javascript_in_rails.md Fix typos on Working with JS page 2024-03-29 12:55:28 -04:00