Skip to content

docs: Add README to dom-utils, rules and table packages - #387

Merged
ymrl merged 1 commit into
mainfrom
docs/add-package-readmes
Oct 1, 2026
Merged

ymrl merged 1 commit into
mainfrom
docs/add-package-readmes

Conversation

@ymrl

@ymrl ymrl commented Oct 1, 2026

Copy link
Copy Markdown
Owner

Summary

Add a README.md to each of packages/dom-utils, packages/rules, and packages/table so that each package can be understood and used on its own, outside the browser extension.

Each README covers:

  • What the package does and its requirements (real browser DOM is needed; jsdom/happy-dom are not accurate)
  • How to depend on it in this monorepo (workspace:*, TypeScript sources are exported directly)
  • Usage examples
  • API reference for all public exports
  • How to run tests and lint

packages/rules/README.md also explains the RuleResult shapes, that message is a translation key (with messageParams placeholders), and lists each rule.

Documentation only; no code changes, so no changeset.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ymrl
ymrl merged commit a4909f2 into main Oct 1, 2026
8 checks passed
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