Skip to content

Adoption hardening: task docs, metadata, and JSR quality gates#110

Merged
Ismail-elkorchi merged 3 commits intomainfrom
codex/adoption-hardening-20260306
Mar 7, 2026
Merged

Adoption hardening: task docs, metadata, and JSR quality gates#110
Ismail-elkorchi merged 3 commits intomainfrom
codex/adoption-hardening-20260306

Conversation

@Ismail-elkorchi
Copy link
Copy Markdown
Owner

@Ismail-elkorchi Ismail-elkorchi commented Mar 6, 2026

What changed for users

  • Added task-oriented docs for fragment parsing, visible-text extraction, traversal, parser limits, and the parsing-versus-sanitization boundary.
  • Tightened the public front door so the README, docs index, package metadata, and JSR overview now describe the same HTML parsing surface.
  • Switched npm-facing README documentation links to absolute GitHub URLs and kept the user docs map free of maintainer pages.

Generated docs / docblocks

  • Kept the JSR overview and public entrypoint wording aligned with the package purpose.
  • Verified the selected public surfaces with the existing JSR docs quality gate.

Biggest adoption blocker fixed

  • First-time users no longer have to guess whether the package is for fragment parsing, visible-text extraction, or structural traversal.

Verification commands

  • npm ci
  • env -u NODE_OPTIONS volta run --node 20 npm run check:fast
  • env -u NODE_OPTIONS volta run --node 22 npm run check:fast
  • npm run check:fast
  • npm run docs:lint:jsr
  • npm run docs:test:jsr
  • npm run examples:run
  • npm run docs:quality:jsr
  • npm pack --dry-run

Manual operator steps

  • None.

@Ismail-elkorchi Ismail-elkorchi merged commit 5b673e3 into main Mar 7, 2026
9 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