chore(docs): remove tmp-builder-codes-outline.mdx from repo root#1716
Open
Kewe63 wants to merge 1 commit into
Open
chore(docs): remove tmp-builder-codes-outline.mdx from repo root#1716Kewe63 wants to merge 1 commit into
Kewe63 wants to merge 1 commit into
Conversation
The file `tmp-builder-codes-outline.mdx` (prefixed with `tmp-`, indicating
a temporary working draft) is committed at the repository root and publicly
visible on master. The draft content is also factually incorrect: it
renders `capabilities` as an array (`capabilities: [{ dataSuffix }]`) when
the actual ERC-5792 spec defines it as an object — contradicting the
canonical `docs/apps/builder-codes/` pages (which correctly use the
object form throughout).
Production documentation already lives under `docs/apps/builder-codes/`
and has no dependency on this draft, so removing the draft file:
- Prevents developers from copy-pasting the array-form example, which
would produce invalid ERC-5792 calls rejected by spec-compliant wallets
- Cleans up the repo root from non-production files
- Resolves the duplicate of issue base#1473 (capabilities field format)
transitively, since the only canonical place the array form appeared
was this draft
Closes base#1472
Collaborator
🟡 Heimdall Review Status
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #1472
The file
tmp-builder-codes-outline.mdxis committed at the repository root with atmp-prefix that signals "temporary working draft." It is publicly visible on master.The draft content is also factually incorrect: it renders
capabilitiesas an array:when the actual ERC-5792 spec defines
capabilitiesas an object. This contradicts the canonicaldocs/apps/builder-codes/pages (lines verified —builder-codes.mdx:98,wallet-developers.mdx,app-developers.mdx:201), which correctly use the object form throughout. A developer copy-pasting the draft example would produce invalid ERC-5792 calls that spec-compliant wallets reject.Deleted the draft. Production docs under
docs/apps/builder-codes/have no dependency on it, so removal is safe.Changes
tmp-builder-codes-outline.mdx— deleted (342 lines removed, no additions). Contained "Builder Codes Implementation" and "Implementation for Wallets" draft sections.Verification
grep -rn tmp-builder-codes-outline docs/returns zero hits — no internal links depend on it.docs/apps/builder-codes/builder-codes.mdx,wallet-developers.mdx,app-developers.mdx) already use the object-formcapabilities. Deleting the draft is consistent with that.git diff --stat HEADshows only this single file deletion (-342).Side Benefit
This transitively resolves issue #1473 ("[Bug] capabilities field incorrectly shown as array in ERC-5792 code examples"), which referenced only
tmp-builder-codes-outline.mdx— there is no other in-tree location using the array form. The canonicaldocs/builder-codesfiles already use the object form, so the array-form bug is fully removed by this deletion.Checklist
grepconfirms no refs from other filesgit diff --statshows 1 file, -342 linesdocs/)Risk & Impact
None. Deletion of an unreferenced, factually incorrect draft file at the repo root. No canonical docs, nav config, or code depend on it.
Type: 🧹 Chore
Closes: #1472