Skip to content

conflict-proof shared docs: oracle-assumptions register as one file per entry (generated summary table), entry IDs allocated at issue time #4788

Closed

Description

@squid-protocol

Owner-approved efficiency work (2026-10-09). docs/language_status/oracle_assumptions.md is one large hand-edited file. Parallel PRs collided on its summary table and on entry numbering (X30/X31/X32 on 2026-10-09: #4762, #4766, #4773). Every slice needed a merge from main plus a re-render.

Change:

  • One file per entry (e.g. docs/language_status/register/X31.md, with front-matter for the status and the summary line).
  • The summary table and the combined page are generated by a tool and checked in CI, like other generated pages.
  • A tiny allocator, register.py next X, plus the rule "take the ID when the issue is filed", so parallel PRs never pick the same number.
  • Migrate the existing entries without any content change.

Acceptance:

  • Two PRs adding entries in the same family no longer conflict.
  • The combined page is byte-identical to today's content, apart from ordering and format.
  • Links still resolve.

🤖 Generated with Claude Code

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature, sensor, or structural signaturepriority: highCore feature broken, but workarounds existscope:infraCI, tooling, churn/factory, docs infrastructuretestingUnit, integration, and E2E pipeline verification

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions