Skip to content

Fix: CAIP-350 typos and misheadings#186

Open
paperclip-minim wants to merge 5 commits into
ChainAgnostic:mainfrom
paperclip-minim:fix/caip-350-typos-and-misheadings
Open

Fix: CAIP-350 typos and misheadings#186
paperclip-minim wants to merge 5 commits into
ChainAgnostic:mainfrom
paperclip-minim:fix/caip-350-typos-and-misheadings

Conversation

@paperclip-minim
Copy link
Copy Markdown

@paperclip-minim paperclip-minim commented May 19, 2026

The CAIP-350 template has the following problems:

  • Some sections that shouldn't be siblings (in terms of headings) are siblings
  • There's a dash instead of an arrow for customary to text conversion
  • The customary<->text and native<->text conversion subsections use 'representation' redundantly, while the analogous binary<->text subsections don't.

The current structure is

[H2] Namespace Reference
[H2] Chain reference
  [H3] Text representation
      [H5] Text representation -> customary (CAIP-2) conversion
      [H5] Customary (CAIP-2) conversion - text representation conversion
    [H4] Binary representation
    [H4] Text -> binary conversion
    [H4] Binary -> text conversion
    [H4] Examples
[H2] Addresses
  [H3] Text representation
      [H5] Text representation -> native representation conversion
      [H5] Native representation -> text representation conversion
    [H4] Binary representation
    [H4] Text -> binary conversion
    [H4] Binary -> text conversion
    [H4] Examples
  [H3] Error handling
  [H3] Implementation considerations
  [H3] Extra considerations

This is also true for every profile derived from it. The Solana profile also has a stray question mark in the customary to text conversion section.

This PR simultaneously fixes all of these section names and heading levels.

[H2] Namespace Reference
[H2] Chain reference
  [H3] Text representation
    [H4] Text -> customary (CAIP-2) conversion
    [H4] Customary (CAIP-2) -> text conversion
  [H3] Binary representation
    [H4] Text -> binary conversion
    [H4] Binary -> text conversion
  [H3] Examples
[H2] Addresses
  [H3] Text representation
    [H4] Text -> native conversion
    [H4] Native -> text conversion
  [H3] Binary representation
    [H4] Text -> binary conversion
    [H4] Binary -> text conversion
  [H3] Examples
[H2] Error handling
[H2] Implementation considerations
[H2] Extra considerations

Everything else is left untouched

Copy link
Copy Markdown
Contributor

@0xrcinus 0xrcinus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense to me

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.

2 participants