xrpl-dev-portal icon indicating copy to clipboard operation
xrpl-dev-portal copied to clipboard

Migrate callout syntax to Redocly format

Open mDuo13 opened this issue 1 year ago • 0 comments

This was originally scripted as part of #2259 but for some reason the script stopped working or missed a bunch of instances.

Example:

Before / old syntax:

**Note:** Any Offer in the DEX that would exchange two tokens can use XRP as an intermediary currency in a synthetic order book. The XRPL DEX automatically uses this bridging technique to improve exchange rates and liquidity when doing so is cheaper than trading token-to-token.

After / new syntax:

{% admonition type="info" name="Note" %}
Any Offer in the DEX that would exchange two tokens can use XRP as an intermediary currency in a synthetic order book. The XRPL DEX automatically uses this bridging technique to improve exchange rates and liquidity when doing so is cheaper than trading token-to-token.
{% /admonition %}

Both old and new use 4 color-coded categories of callout, but the names are different. In the old syntax, the bolded intro word acts as the title of the callout and also identifies the callout severity. In the new syntax, the visible title and color are set separately.

Color Old Name (en) Old Name (ja) New Type
Green Tip ヒント success
Blue Note 注記 info
Yellow/Orange Caution 注意 warning
Red Warning 警告 danger

When migrating, the old name should go into the name= parameter and the corresponding new type should go into the type= parameter.

mDuo13 avatar Mar 20 '24 19:03 mDuo13