Skip to content

docs: slim README and add getting-started guides with omit markers - #26

Merged
rdlabo merged 1 commit into
mainfrom
docs/readme-omit
Aug 19, 2026
Merged

docs: slim README and add getting-started guides with omit markers#26
rdlabo merged 1 commit into
mainfrom
docs/readme-omit

Conversation

@rdlabo

@rdlabo rdlabo commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Slim the README to the portal Getting Started landing and omit badges, sponsorship, and license.
  • Add docs/configuration.md and docs/rules.md beside the existing per-rule pages.
  • Include docs/ in the npm files list.

Test plan

  • Confirm README links to docs/configuration.md and docs/rules.md.
  • Confirm existing docs/rules/*.md pages are unchanged.
  • After publish, enable englishFromPackage for eslint-plugin-rules in rdlabo-docs.

Made with Cursor

Keep rule pages in docs/rules and add configuration/rules index pages for the docs portal.
@rdlabo
rdlabo merged commit adc708c into main Aug 19, 2026
4 checks passed
@rdlabo
rdlabo deleted the docs/readme-omit branch August 19, 2026 04:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant