Skip to content

Update Nielsen's Heuristics and future phases in README - #31

Closed
devangpratap wants to merge 1 commit into
ruxailab:mainfrom
devangpratap:docs/readme-heuristics
Closed

Update Nielsen's Heuristics and future phases in README#31
devangpratap wants to merge 1 commit into
ruxailab:mainfrom
devangpratap:docs/readme-heuristics

Conversation

@devangpratap

@devangpratap devangpratap commented Mar 2, 2026

Copy link
Copy Markdown

Closes #24

Overview

This PR provides a comprehensive update to the project documentation, ensuring the README reflects the actual capabilities of the heuristic engine and the current strategic roadmap.

Why this PR should be preferred over #25:

While PR #25 (Sushma-1706) provides a basic list update, it is incomplete for the following reasons:

Key Changes

  • Full Heuristic Synchronization: Aligned README with the /api/v1/evaluation/heuristics endpoint.
  • Phase Realignment: Refocused development trajectory on web-crawling and automated inventory building.
  • Formatting Cleanup: Fixed inconsistent Markdown headers to improve readability.

Verification

  • Cross-referenced all IDs against the codebase constants.
  • Verified Markdown rendering for visual consistency.
Screenshot 2026-03-02 at 8 40 17 PM Screenshot 2026-03-02 at 8 40 30 PM Screenshot 2026-03-02 at 8 40 51 PM

Expanded Nielsen's Heuristics mapping from H1-H3 to H1-H10 and added detailed descriptions for H4-H10. Updated future enhancements to specify phases for implementation.
@devangpratap devangpratap closed this by deleting the head repository Jun 20, 2026
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.

README mentions only H1–H3 implemented, but engine supports H1–H10

1 participant