Skip to content

Proposal (docs only): Repeated Word Check UI — Checks tab & Checks panel#305

Open
JEdward7777 wants to merge 2 commits into
mainfrom
jel-checks-ui-proposal
Open

Proposal (docs only): Repeated Word Check UI — Checks tab & Checks panel#305
JEdward7777 wants to merge 2 commits into
mainfrom
jel-checks-ui-proposal

Conversation

@JEdward7777

@JEdward7777 JEdward7777 commented Jun 11, 2026

Copy link
Copy Markdown

Relates to #277, #278 (and fluent-api#172 for the persistence half).

Docs-only proposal PR — no code changes. This is the design-for-review of the Repeated Word Check UI, following the same proposal-PR process as the approved fluent-api proxy design (fluent-api PR #173).

Start here: docs/proposals/repeated-word-check/checks-ui-integration-summary.md — a condensed reviewer summary (core decisions, out-of-scope list, and the specific items where sign-off/input is sought).

Full design: docs/proposals/repeated-word-check/checks-ui-integration-suggestion.md — decisions W1–W12 covering the tab/panel UI, check trigger, suppression cascade, persistence design (editor-state extension + new user_settings table with GET/PUT /users/settings), graceful degradation, rollout, and testing.

One proposal covers both repos so the whole design reads in one place; implementation will ship as two PRs (fluent-web + a small fluent-api PR), and either may land first by design (§9.4).

Items needing explicit confirmation are collected in the proposal's §12 sign-off checklist: five product-level mock/card deviations (S1–S5), the no-new-card ruling for suppression persistence (S6), and three engineering confirmations (W2/W7 user-settings store, W4 occurrence identity, W5/W6 cascade & undo).

Summary by CodeRabbit

  • Documentation
    • Added comprehensive design proposal documentation for Repeated Word Check UI integration, detailing Checks panel specifications, suppression management, notification indicators, and end-to-end flow diagrams with testing strategy and implementation checklist.

@coderabbitai

coderabbitai Bot commented Jun 11, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 5cd5cdfd-bcfd-4896-a58b-7e3a3e3ef8a2

📥 Commits

Reviewing files that changed from the base of the PR and between 0dcea61 and b387419.

📒 Files selected for processing (2)
  • docs/proposals/repeated-word-check/checks-ui-integration-suggestion.md
  • docs/proposals/repeated-word-check/checks-ui-integration-summary.md

📝 Walkthrough

Walkthrough

This PR introduces two new proposal documents specifying the Repeated Word Check UI integration. A concise summary document outlines user-facing scope, core design decisions for suppression persistence, and sign-off confirmations. A detailed proposal document expands on the full specification, including web UI decisions, suppression cascade logic, graceful degradation behavior, and a comprehensive testing plan with specific validation cases.

Changes

Repeated Word Check UI Integration Proposal

Layer / File(s) Summary
Proposal summary and review decisions
docs/proposals/repeated-word-check/checks-ui-integration-summary.md
Overview of user-facing scope (notification dot, checks panel refresh), core decisions (suppression persistence, user_settings table and GET/PUT /users/settings endpoint, chapter-wide verse querying, tri-state suppression cascade with undo), deferred items, and product/engineering confirmations.
Comprehensive design specification and testing plan
docs/proposals/repeated-word-check/checks-ui-integration-suggestion.md
Detailed specification of Checks tab and panel UI (W1–W12 decisions), auto-save and proxy call flow diagram, suppression occurrence identity, active/inactive cascade with tri-state resolution rules and undo/surface semantics, client-side feature detection and graceful degradation when settings backend is unavailable, testing plan for fluent-web and fluent-api (cascade precedence, request gating, endpoint validation), explicitly deferred future work, and sign-off checklist.

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and clearly summarizes the main change: a proposal for the Repeated Word Check UI integration across the Checks tab and Checks panel, matching the documentation-only scope and objectives.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch jel-checks-ui-proposal

Comment @coderabbitai help to get the list of available commands and usage tips.

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