Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make internal links to errors in the Active Record Validations guide #45891

Conversation

elebow
Copy link
Contributor

@elebow elebow commented Aug 26, 2022

Summary

In the Active Record Validations guide, make references to errors links to the API documentation, according to existing convention.

@rails-bot rails-bot bot added the docs label Aug 26, 2022
@p8
Copy link
Member

p8 commented Aug 26, 2022

Hey @elebow.
Just curious. What is the convention here? 🙂
Do we link the first time it's mentioned in a new section?

@elebow
Copy link
Contributor Author

elebow commented Aug 27, 2022

That is how it appears from the rest of the file, but not exactly strictly.

@jonathanhefner
Copy link
Member

The convention that I've been using is to link the first occurrence of a term in the guide, similar to Wikipedia. Sometimes it makes sense to link additional occurrences though. Like when the first occurrence is just mentioning the term in passing, and there is a dedicated section for it later in the guide. Or when there is a summary that lists several terms outside of their dedicated sections. In general, I try to provide convenience while avoiding "link fatigue".

on-behalf-of: @Cofense <oss@cofense.com>
@elebow elebow force-pushed the active-record-validations-guide-internal-link-errors branch from 2bf82b6 to bc5561d Compare September 1, 2022 20:10
@elebow
Copy link
Contributor Author

elebow commented Sep 1, 2022

After a few days of thought, I removed the internal links and reduced the PR to just the typo fix that initially motivated it.

@rafaelfranca rafaelfranca merged commit 1e6ea56 into rails:main Sep 1, 2022
rafaelfranca added a commit that referenced this pull request Sep 1, 2022
…e-internal-link-errors

Make internal links to `errors` in the Active Record Validations guide
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants