Skip to content

docs: add concise documentation for issues 63 and 64 implementations#78

Open
senomorf wants to merge 6 commits intomasterfrom
docs/issues-63-64-implementation-gaps
Open

docs: add concise documentation for issues 63 and 64 implementations#78
senomorf wants to merge 6 commits intomasterfrom
docs/issues-63-64-implementation-gaps

Conversation

@senomorf
Copy link
Owner

Summary

Adds concise documentation covering critical gaps from error-driven limit detection (PR #69) and architecture-aware timeout handling (PR #70) implementations. All content optimized for minimal token count while maintaining completeness.

Documentation Updates

CLAUDE.md (Token-Optimized)

  • Error Classification: Added USER_LIMIT_REACHED (exit code 5) with concise behavior
  • Error-Driven Limit Detection: 4-line essential implementation covering 4,320+ API call savings
  • Architecture-Aware Timeout Handling: 3-line core logic preserving capacity errors

docs/limits-management.md (New)

  • Essential Commands: limit-status, check-limit, clear-limits, set-limit
  • Free Tier Limits: E2 (2 max), A1 (4 OCPUs total)
  • Key Behaviors: Exit codes, cache TTL, pre-flight checks

docs/troubleshooting.md (Minimal Addition)

  • User Limit Troubleshooting: Exit code 5 handling (8 lines)
  • Updated Validation: Added USER_LIMIT_REACHED to exit code tests

README.md (Concise Updates)

  • Feature List: Added error-driven detection and timeout handling
  • Documentation Reference: Added limits-management.md link

Key Benefits

  • Closes documentation gaps for two major feature implementations
  • Token-efficient approach - especially optimized CLAUDE.md for context usage
  • Essential information only - removed verbose explanations, kept actionable content
  • Maintains project consistency - follows existing documentation patterns

Coverage Analysis

Before: Missing documentation for:

  • Error-driven limit detection behavior and commands
  • New exit code 5 (USER_LIMIT_REACHED)
  • Architecture-aware timeout handling improvements
  • State manager limit management commands

After: Complete coverage with minimal token overhead

Implementation Details

  • Zero API Overhead: Documents how limit detection learns from natural failures
  • 24-Hour Cache TTL: Explains automatic limit state management
  • Smart Shape Filtering: Pre-flight cache checks prevent futile attempts
  • Timeout Race Condition Fix: Architecture-aware handling preserves error codes

Total addition: ~70 lines across 4 files, covering comprehensive feature documentation.

…conditions

- Enable notifications for scheduled runs by default (monitor automation)
- Remove notifications for user limits reached (expected free tier behavior)
- Remove notifications for instance already exists (expected with state management)
- Remove unused notify_capacity_unavailable() function
- Add comprehensive Telegram notification policy to CLAUDE.md

This resolves issue #76 where users received unwanted notifications for
normal operational conditions that resolve automatically through retry cycles.

Key changes:
- Workflow: ENABLE_NOTIFICATIONS=true for scheduled runs, user choice for manual
- Scripts: Remove 3 unwanted notification calls for expected conditions
- Docs: Clear policy on when to send/not send notifications

Expected behavior:
- Scheduled runs: Notifications enabled, only for successes/actionable failures
- Manual runs: User can toggle notifications via workflow dispatch
- Expected conditions: Silent (limits, capacity constraints, duplicates)
- Actual failures: Always notify (auth errors, config errors, unknowns)

Fixes #76
- Disable all Prettier validators in super-linter (style conflicts)
- Add .markdownlint.json config to disable MD026, MD013, MD033 style rules
- Document comprehensive linter policy in CLAUDE.md
- Establish no-style-rules principle for all project linters
- Add Claude review command guidelines for linter validation

Fixes PR #77 check failures while maintaining readable documentation
- Add linter policy validation to auto-review checklist
- Ensure future reviews check that new linters focus on quality/security/functional issues
- Prevent introduction of arbitrary style-only linting rules
- Remove Claude Review Command section that duplicates auto-review command
- Keep linter policy documentation concise and avoid redundancy
- Auto-review command now contains the detailed validation criteria
- Add concise Documentation section with links to key policies
- Highlight notification policy and linter configuration changes
- Improve project navigation and policy discoverability
Cover critical gaps from error-driven limit detection (PR #69) and
architecture-aware timeout handling (PR #70) while optimizing for token efficiency.

- Add USER_LIMIT_REACHED (exit code 5) to error classification
- Document error-driven limit detection preventing 4,320+ monthly API calls
- Add architecture-aware timeout handling preserving capacity errors
- Create limits-management.md with essential state manager commands
- Add minimal troubleshooting for user limit scenarios
- Update README features with concise descriptions

All additions optimized for minimal token count while maintaining completeness.
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