Skip to content

docs: update README to reflect H1–H10 heuristic support - #25

Open
Sushma-1706 wants to merge 1 commit into
ruxailab:mainfrom
Sushma-1706:fix-readme-heuristics
Open

docs: update README to reflect H1–H10 heuristic support#25
Sushma-1706 wants to merge 1 commit into
ruxailab:mainfrom
Sushma-1706:fix-readme-heuristics

Conversation

@Sushma-1706

@Sushma-1706 Sushma-1706 commented Feb 21, 2026

Copy link
Copy Markdown

Summary

This PR updates the README to accurately reflect the current heuristic evaluation coverage.

Although the README stated that only H1–H3 were implemented under "Phase 1", the API currently supports evaluation for all 10 Nielsen Heuristics (H1–H10).

This update ensures that documentation aligns with the actual system behavior.


Changes Made

  • Updated heuristic coverage section in README
  • Clarified that H1–H10 are supported
  • Removed outdated "Phase 1 (H1–H3 only)" wording

Why This Matters

Accurate documentation:

  • Reduces confusion for contributors
  • Prevents incorrect assumptions about feature coverage
  • Improves onboarding experience for new developers

No functional changes were made.
This solves issue #24

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