-
Notifications
You must be signed in to change notification settings - Fork 6
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
Update default rule doc title format and show description notice by default #347
Comments
One note is that we do have an option As for the description, we need to implement a NOTICE_TYPE to include the description under the title. This would enable us to ensure we still include the description even after a change to the default title format. Done in: #350. |
Right now, the main title on each rule page is the old ESLint format of "description (rule-id)", which can be quite long.
The ESLint docs switched to having the rule-id as the primary heading with the description underneath it, so I'd like to see this change here as well.
The text was updated successfully, but these errors were encountered: