Skip to content

[docs] docs: Developer documentation consolidation v5.3 — GitHub API rate limit observability#24709

Merged
pelikhan merged 1 commit intomainfrom
docs/rate-limit-observability-v5.3-17df1f25d09d3d23
Apr 5, 2026
Merged

[docs] docs: Developer documentation consolidation v5.3 — GitHub API rate limit observability#24709
pelikhan merged 1 commit intomainfrom
docs/rate-limit-observability-v5.3-17df1f25d09d3d23

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions bot commented Apr 5, 2026

Documents the GitHub API rate limit observability feature introduced in PR #24694.

Changes Made

  • Created scratchpad/github-rate-limit-observability.md — new spec file covering the github_rate_limit_logger.cjs helper, three usage patterns (per-call, snapshot, auto-wrap), JSONL artifact upload, and OTLP span enrichment
  • Updated scratchpad/dev.md to v5.3:
    • Added GitHub API Rate Limit Observability subsection to the MCP Integration section
    • Added new Related Documentation link to the spec file
    • Bumped version header and Document History

Coverage

  • Previous: 72 spec files (v5.2)
  • Current: 73 spec files (v5.3)
  • Tone issues found: 0
  • Diagrams added: 0

Review Notes

  1. The new subsection in MCP Integration (dev.md) summarizes all three JS usage patterns plus artifact paths and OTLP attributes
  2. The standalone spec file (github-rate-limit-observability.md) includes a jq debugging reference
  3. Tone is neutral and technical throughout — no marketing language

References: §24000151858

Generated by Developer Documentation Consolidator · ● 454.1K ·

  • expires on Apr 7, 2026, 11:12 AM UTC

Documents PR #24694 feature: JSONL artifact logging and OTLP span
enrichment for GitHub API rate-limit visibility. Creates new spec file
and adds MCP Integration subsection to dev.md.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Apr 5, 2026
@pelikhan pelikhan merged commit d20074e into main Apr 5, 2026
@pelikhan pelikhan deleted the docs/rate-limit-observability-v5.3-17df1f25d09d3d23 branch April 5, 2026 11:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant