[developer-docs] Developer Documentation Consolidation - 2026-04-05

[github-actions[bot]]

Daily consolidation run for 2026-04-05. Analysis identified one new feature implementation (PR #24694) requiring documentation.

Summary

• Files analyzed: 1 new spec file created
• Total spec coverage: 73 files (previously 72)
• Tone issues found: 0
• Mermaid diagrams added: 0
• New Related Documentation links: 1
• Version: 5.2 → 5.3

New Feature Documented

GitHub API Rate Limit Observability (PR #24694, merged 2026-04-05)

A new observability feature for GitHub API rate limits was merged after the v5.2 run. It had no corresponding spec file. Created scratchpad/github-rate-limit-observability.md and added a subsection to scratchpad/dev.md (MCP Integration section).

Feature Details

What was added in PR #24694

Component	File	Description
JS helper	actions/setup/js/github_rate_limit_logger.cjs	Three usage patterns for rate-limit logging
Go constant	pkg/constants/job_constants.go	GithubRateLimitsFilename = "github_rate_limits.jsonl"
Compiler	compiler_activation_job.go	Artifact upload path added
Compiler	compiler_yaml_main_job.go	Artifact upload path added
OTLP	send_otlp_span.cjs	Four rate-limit attributes in conclusion span

Three JS Usage Patterns Documented

1. Per-call (logRateLimitFromResponse) — reads x-ratelimit-* headers from REST response
2. On-demand snapshot (fetchAndLogRateLimit) — calls the GitHub rate-limit API
3. Auto-wrap (createRateLimitAwareGithub) — Proxy wraps all github.rest.*.*() calls

The setupGlobals integration means all scripts using global.github get automatic logging.

OTLP Span Attributes

• gh-aw.github.rate_limit.remaining
• gh-aw.github.rate_limit.limit
• gh-aw.github.rate_limit.used
• gh-aw.github.rate_limit.resource

Tone Scan

Maintenance tone scan across all existing spec files: 0 issues found.

Validation

• Markdown valid: ✅
• Code blocks have language tags: ✅
• No broken links: ✅
• Technical tone throughout: ✅
• Document History updated: ✅

Historical Comparison

Run	Date	New Files	Tone Fixes	Coverage
v5.3	2026-04-05	1	0	73
v5.2	2026-04-04	0	0	72
v5.1	2026-04-03	3	0	72
v5.0	2026-04-02	7	3	69

References: §24000151858

Generated by Developer Documentation Consolidator · ● 454.1K · ◷

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

[github-actions[bot]]

This discussion has been marked as outdated by Developer Documentation Consolidator.

A newer discussion is available at Discussion #25275.