Fix broken documentation references #3180

emmanuel-ferdman · 2025-07-02T16:40:18Z

PR Summary

This PR is a bit large, as it resolves broken links to the XRPLF/rippled repository introduced by this commit. Key changes include:

Updated all relevant file references to use commit 1e01cd34f7a216092ed779f291b43324c167167a, which is the latest commit on XRPLF/rippled master (v2.5.0).
Removed links to shard files that were deleted in commit 7d27b1119092e3195238a1897d6012c3372e6c53.
Adjusted line references where applicable - some did not require changes.
Due to the inclusion of translated pages, the scope of this PR is wider than usual.
used 'xrplf' -> 'XRPLF' as GitHub org.
There are changes in blog directory that I didn't upload because the PR is large enough. Let me know if you want them as separate PR.

Let me know if I missed anything or if further changes are needed.

mDuo13

I appreciate the effort, but I have to cast doubt on the claim that you have put a lot of effort into ensuring that everything is correct when about ¼ of the changes I spot-checked go to a 404 page.

Please correct the cases where you combine an old commit ID with a new path.

docs/concepts/accounts/cryptographic-keys.md

docs/concepts/consensus-protocol/consensus-structure.md

docs/concepts/consensus-protocol/invariant-checking.md

tequdev

The same changes should apply to translated pages (since they are not language-dependent)

Signed-off-by: Emmanuel Ferdman <[email protected]>

emmanuel-ferdman · 2025-07-19T22:06:01Z

@mDuo13 @tequdev both of you are correct. I hope the new PR reflects both your feedback and resolves the remaining broken references cleanly. Let me know if anything else needs tweaking.

mDuo13

Thank you for coming back with fixes. I'm of two minds about the decision to use the version 2.5.0 commit for all the source links, because it means we might have to go replace a lot more links to keep them up to date with the latest release even if the source code didn't move. On the other hand, it ensures the links will go to the accurate part of the code for that release, and seems especially helpful for the ones with line numbers.

Unfortunately, I did still find several issues with the links, in particular the ones for the ledger entry ID formulas. There are at least a few cases where the line numbers in the updated links are also still wrong, too. And I noticed at least one case where you updated the link in the Japanese-translated version of the page but left the outdated link in the English version of the same file.

I'd like to be able to merge this one, since it does fix a lot of broken source links, but I want to make sure we get it right.

mDuo13 · 2025-07-22T17:31:16Z

@l10n/ja/docs/references/protocol/binary-format.md


 - `0xff`は別のパスが続くことを示します。
 - `0x00`はPathSetの終わりを示します。

-各パスには**1～8**のパスステップがこの順序で含まれています[[ソース]](https://github.com/XRPLF/rippled/blob/4cff94f7a4a05302bdf1a248515379da99c5bcd4/src/ripple/app/tx/impl/Payment.h#L38-L39 "Source")。各ステップは**タイプ**を示すバイトで始まり、その後にパスステップを記述する1つ以上のフィールドが続きます。タイプは、ビット単位のフラグを使用してそのパスステップに含まれるフィールドを示します。（たとえば値が`0x30`の場合、通貨とイシュアーの両方が変更されます。）複数のフィールドが含まれている場合、フィールドは常に特定の順序で配置されます。
+各パスには**1～8**のパスステップがこの順序で含まれています[[ソース]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/xrpld/app/tx/detail/Payment.h#L38-L39 "Source")。各ステップは**タイプ**を示すバイトで始まり、その後にパスステップを記述する1つ以上のフィールドが続きます。タイプは、ビット単位のフラグを使用してそのパスステップに含まれるフィールドを示します。（たとえば値が`0x30`の場合、通貨とイシュアーの両方が変更されます。）複数のフィールドが含まれている場合、フィールドは常に特定の順序で配置されます。


The line numbers here are wrong:

Suggested change

各パスには**1～8**のパスステップがこの順序で含まれています[[ソース]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/xrpld/app/tx/detail/Payment.h#L38-L39 "Source")。各ステップは**タイプ**を示すバイトで始まり、その後にパスステップを記述する1つ以上のフィールドが続きます。タイプは、ビット単位のフラグを使用してそのパスステップに含まれるフィールドを示します。（たとえば値が`0x30`の場合、通貨とイシュアーの両方が変更されます。）複数のフィールドが含まれている場合、フィールドは常に特定の順序で配置されます。

各パスには**1～8**のパスステップがこの順序で含まれています[[ソース]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/xrpld/app/tx/detail/Payment.h#L32-L33 "Source")。各ステップは**タイプ**を示すバイトで始まり、その後にパスステップを記述する1つ以上のフィールドが続きます。タイプは、ビット単位のフラグを使用してそのパスステップに含まれるフィールドを示します。（たとえば値が`0x30`の場合、通貨とイシュアーの両方が変更されます。）複数のフィールドが含まれている場合、フィールドは常に特定の順序で配置されます。

mDuo13 · 2025-07-22T17:38:38Z

@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/accountroot.md

@@ -44,7 +44,7 @@ labels:
 | `AMMID`                       | 文字列    | UInt256           | いいえ | _([AMM amendment][]により追加されました。)_ 対応するAMMレジャーエントリのレジャーエントリID。アカウント作成時に設定します。AMM以外のアカウントでは常に省略されます。 |
 | `Balance`                     | 文字列    | Amount            | いいえ | アカウントの現在の[drop単位のXRP残高][XRP、drop単位]で、文字列で表現されます。 |
 | `BurnedNFTokens`              | 数値      | UInt32            | いいえ | このアカウントで発行された [非代替性トークン](../../../../concepts/tokens/nfts/index.md) のうち、バーンしたトークンの総数を表します。この数値は常に `MintedNFTokens` と同じかそれ以下となります。 |
-| `Domain`                      | 文字列    | VariableLength    | いいえ | このアカウントに関連付けられたドメイン。JSONでは、ドメインのASCII表現を16進数で表現します。[256バイトを超える長さは使用できません](https://github.com/xrplf/rippled/blob/55dc7a252e08a0b02cd5aa39e9b4777af3eafe77/src/ripple/app/tx/impl/SetAccount.h#L34) |
+| `Domain`                      | 文字列    | VariableLength    | いいえ | このアカウントに関連付けられたドメイン。JSONでは、ドメインのASCII表現を16進数で表現します。[256バイトを超える長さは使用できません](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/xrpld/app/tx/detail/SetAccount.h#L34) |


This constant has moved here:

Suggested change

| `Domain` | 文字列 | VariableLength | いいえ | このアカウントに関連付けられたドメイン。JSONでは、ドメインのASCII表現を16進数で表現します。[256バイトを超える長さは使用できません](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/xrpld/app/tx/detail/SetAccount.h#L34) |

| `Domain` | 文字列 | VariableLength | いいえ | このアカウントに関連付けられたドメイン。JSONでは、ドメインのASCII表現を16進数で表現します。[256バイトを超える長さは使用できません](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/include/xrpl/protocol/Protocol.h#L98) |

The same should apply to the English version too (docs/references/protocol/ledger-data/ledger-entry-types/accountroot.md line 45)

mDuo13 · 2025-07-22T17:44:14Z

docs/references/protocol/ledger-data/ledger-entry-types/check.md

@@ -64,7 +64,7 @@ There are no flags defined for {% code-page-name /%} entries.


 ## Check ID Format
-[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/Indexes.cpp#L193-L200 "Source")
+[[Source]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/libxrpl/protocol/Indexes.cpp#L195-L201 "Source")


Correct link (as in the Japanese version):

Suggested change

[[Source]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/libxrpl/protocol/Indexes.cpp#L195-L201 "Source")

[[Source]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/libxrpl/protocol/Indexes.cpp#L335-L339 "Source")

mDuo13 · 2025-07-22T17:44:56Z

@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/check.md

@@ -65,7 +65,7 @@ _（[Checks Amendment][]が必要です）_


 ## Check IDのフォーマット
-[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/Indexes.cpp#L193-L200 "Source")
+[[ソース]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/libxrpl/protocol/Indexes.cpp#L195-L201 "Source")


Correct line numbers for the Check ID format:

Suggested change

[[ソース]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/libxrpl/protocol/Indexes.cpp#L195-L201 "Source")

[[ソース]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/libxrpl/protocol/Indexes.cpp#L335-L339 "Source")

mDuo13 · 2025-07-22T17:48:11Z

@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/ledgerhashes.md

@@ -65,7 +65,7 @@ labels:
 「過去の履歴」`LedgerHashes`オブジェクトは[スキップリスト](https://en.wikipedia.org/wiki/Skip_list)として機能するので、任意の履歴フラッグレジャーのハッシュをそのインデックスから取得できます。さらに、フラッグレジャーの「最近の履歴」オブジェクトを使用してその他のレジャーのハッシュを取得できます。

 ## LedgerHashes IDのフォーマット
-[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/Indexes.cpp#L26-L42)
+[[ソース]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/libxrpl/protocol/Indexes.cpp#L26-L42)


Here are the correct line numbers for LedgerHashes ID formats:

Suggested change

[[ソース]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/libxrpl/protocol/Indexes.cpp#L26-L42)

[[ソース]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/libxrpl/protocol/Indexes.cpp#L195-L211)

mDuo13 · 2025-07-22T17:50:39Z

@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/oracle.md

@@ -2,7 +2,7 @@

 _([PriceOracle Amendment][])_

-[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/LedgerFormats.cpp#L353-L366 "ソース")
+[[ソース]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/include/xrpl/protocol/detail/ledger_entries.macro#L385-L395 "ソース")


Correct line numbers:

Suggested change

[[ソース]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/include/xrpl/protocol/detail/ledger_entries.macro#L385-L395 "ソース")

[[ソース]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/include/xrpl/protocol/detail/ledger_entries.macro#L433-L443 "ソース")

mDuo13 self-requested a review July 9, 2025 19:15

mDuo13 reviewed Jul 9, 2025

View reviewed changes

docs/concepts/accounts/cryptographic-keys.md Outdated Show resolved Hide resolved

docs/concepts/consensus-protocol/consensus-structure.md Outdated Show resolved Hide resolved

docs/concepts/consensus-protocol/invariant-checking.md Outdated Show resolved Hide resolved

tequdev reviewed Jul 14, 2025

View reviewed changes

Fix broken documentation references

f585e23

Signed-off-by: Emmanuel Ferdman <[email protected]>

emmanuel-ferdman force-pushed the master branch from ba25032 to f585e23 Compare July 19, 2025 21:58

mDuo13 mentioned this pull request Jul 22, 2025

Remove history shard API method docs & add redirects #3208

Open

mDuo13 requested changes Jul 22, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix broken documentation references #3180

Fix broken documentation references #3180

emmanuel-ferdman commented Jul 2, 2025 •

edited

Loading

Uh oh!

mDuo13 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tequdev left a comment

Uh oh!

emmanuel-ferdman commented Jul 19, 2025

Uh oh!

mDuo13 left a comment

Uh oh!

mDuo13 Jul 22, 2025

Uh oh!

mDuo13 Jul 22, 2025

Uh oh!

mDuo13 Jul 22, 2025

Uh oh!

mDuo13 Jul 22, 2025

Uh oh!

mDuo13 Jul 22, 2025

Uh oh!

mDuo13 Jul 22, 2025

Uh oh!

Uh oh!

	\| `Domain` \| 文字列 \| VariableLength \| いいえ \| このアカウントに関連付けられたドメイン。JSONでは、ドメインのASCII表現を16進数で表現します。[256バイトを超える長さは使用できません](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/xrpld/app/tx/detail/SetAccount.h#L34) \|
	\| `Domain` \| 文字列 \| VariableLength \| いいえ \| このアカウントに関連付けられたドメイン。JSONでは、ドメインのASCII表現を16進数で表現します。[256バイトを超える長さは使用できません](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/include/xrpl/protocol/Protocol.h#L98) \|

	[[Source]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/libxrpl/protocol/Indexes.cpp#L195-L201 "Source")
	[[Source]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/libxrpl/protocol/Indexes.cpp#L335-L339 "Source")

	[[ソース]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/libxrpl/protocol/Indexes.cpp#L195-L201 "Source")
	[[ソース]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/libxrpl/protocol/Indexes.cpp#L335-L339 "Source")

Fix broken documentation references #3180

Are you sure you want to change the base?

Fix broken documentation references #3180

Conversation

emmanuel-ferdman commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

Uh oh!

mDuo13 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tequdev left a comment

Choose a reason for hiding this comment

Uh oh!

emmanuel-ferdman commented Jul 19, 2025

Uh oh!

mDuo13 left a comment

Choose a reason for hiding this comment

Uh oh!

mDuo13 Jul 22, 2025

Choose a reason for hiding this comment

Uh oh!

mDuo13 Jul 22, 2025

Choose a reason for hiding this comment

Uh oh!

mDuo13 Jul 22, 2025

Choose a reason for hiding this comment

Uh oh!

mDuo13 Jul 22, 2025

Choose a reason for hiding this comment

Uh oh!

mDuo13 Jul 22, 2025

Choose a reason for hiding this comment

Uh oh!

mDuo13 Jul 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

emmanuel-ferdman commented Jul 2, 2025 •

edited

Loading