Skip to content

docs: refresh README.md with explainer and options types #63

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Nov 24, 2024
Merged

docs: refresh README.md with explainer and options types #63

merged 2 commits into from
Nov 24, 2024

Conversation

@JoshuaKGoldberg
Copy link
Contributor

@JoshuaKGoldberg JoshuaKGoldberg commented Nov 24, 2024 •
edited
Loading

Fixes #28. Fixes #62.

"Refreshes" (ha) the README.md:

  • Adds a top-level explainer for what "fast refresh" / "hot reloading" are with a link to react-refresh
  • Explicitly calls out in a few places that there's just the one only-export-components rule
  • Moved Flat config to the primary location and Legacy config to its own section
  • Adds basic types & default options docs for options, similar to how they're shown in typescript-eslint.io/rules

@JoshuaKGoldberg JoshuaKGoldberg mentioned this pull request Nov 24, 2024
Closed
ArnaudBarre
ArnaudBarre approved these changes Nov 24, 2024
View reviewed changes
Copy link
Owner

@ArnaudBarre ArnaudBarre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks you for this 🙏🙏

@ArnaudBarre ArnaudBarre merged commit 599b0fd into ArnaudBarre:main Nov 24, 2024
1 check passed
@JoshuaKGoldberg JoshuaKGoldberg deleted the docs-refresh branch November 24, 2024 20:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ArnaudBarre ArnaudBarre ArnaudBarre approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Docs: per-rule docs (eslint-doc-generator)? Please add better description what it does

2 participants

@JoshuaKGoldberg @ArnaudBarre