Skip to content

Add edge-case guidance and correct stale facts in AGENTS.md - #509

Merged
imnasnainaec merged 2 commits into
mainfrom
docs/edge-case-guidance
Oct 26, 2026
Merged

imnasnainaec merged 2 commits into
mainfrom
docs/edge-case-guidance

Conversation

@imnasnainaec

@imnasnainaec imnasnainaec commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Adds an Edge cases section to AGENTS.md and corrects text there that had drifted from the code.

 ## Architecture
   ...
+## Edge cases
+  weigh cost (code, tests, docs; maintenance and agent context) against:
+    danger, real use, blocking
+  not worth handling -> throw a clear error naming the unsupported case
 ## Testing

Corrections:

  • activate / deactivate: the registration list missed validators; deactivate also closes sessions. The list is now quantity-free.
  • Project modals: path moved to src/components/modals/; the state list and modal count were stale.
  • Project storage: four serialization queues, not two (now unnumbered).
  • InterlinearProject: field list was incomplete; now described without enumerating fields.
  • Mock files: papi-frontend.ts description was partial; the two *-experimental mocks were missing.
  • Dropped the "Mock internals" bullets that repeated the Testing intro and the WebView contract note.
  • Rewrote three passages that misread on first pass (modal onClose, sessions, section-heading filing).

Merge Danger

Door: two-way

Blast Radius: docs-only

Changes only what agents read; no code or build impact.

🤖 Generated with Claude Code


This change is Reviewable

Summary by CodeRabbit

  • Documentation
    • Updated project guidance to clarify expected behavior across lifecycle operations, project dialogs and storage, analysis sessions, and dialog dismissal.
    • Added recommendations for handling unsupported edge cases, including when to report a clear error.
    • Expanded testing guidance to cover additional experimental package entry points and refreshed related project and data-model guidance. No application behavior or public declarations changed.

imnasnainaec and others added 2 commits October 26, 2026 11:33
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Fix claims that drifted from the code (activate/deactivate, modal paths
and states, storage queues, InterlinearProject fields, mock files), drop
the mock-setup bullets duplicated from the Testing intro, and rewrite
three passages that misled on first read.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 840fc4f6-f4b1-4541-ac61-ce4ea05e46fb
Commits

Reviewing files that changed from the base of the PR and between c82db70 and c5c93d1.

Files selected for processing: 1
  • AGENTS.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

This change updates AGENTS.md with revised dependency, lifecycle, project, session, data-model, edge-case, and test-mock guidance. It changes documentation only; no implementation or exported declarations change.

Changes: Repository guidance

Layer / File(s) Summary
Dependency baseline and lifecycle guidance
AGENTS.md
Clarifies the template dependency baseline and notes that deactivation closes every session.
Project, session, and data-model guidance
AGENTS.md
Updates descriptions of project modals and storage, session commands and dismissal, interlinear project data, and heading placement.
Edge-case and mock guidance
AGENTS.md
Adds criteria for handling unsupported edge cases and updates the mock inventory with experimental PAPI package entry points.

Priority: Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Possibly related PRs

Suggested reviewers: alex-rawlings-yyc

Merge Risk: Minimal · up to c5c93

No merge-blocking implementation or build risk is identified.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main documentation changes: adding edge-case guidance and correcting stale facts in AGENTS.md.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@imnasnainaec
imnasnainaec marked this pull request as ready for review October 26, 2026 15:40
@imnasnainaec imnasnainaec self-assigned this Oct 26, 2026

@alex-rawlings-yyc alex-rawlings-yyc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alex-rawlings-yyc reviewed 1 file and all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on imnasnainaec).

@imnasnainaec
imnasnainaec merged commit aaf6935 into main Oct 26, 2026
10 checks passed
@imnasnainaec
imnasnainaec deleted the docs/edge-case-guidance branch October 26, 2026 15:57
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.

2 participants