updated docs

xrpl-hooks-docs/md/hooks-field-add-buf-len.md

@@ -1,9 +1,5 @@
 # hooks-field-add-buf-len
 
-Emplacing a new field into STObject by calling `sto_emplace` requires
-enough space to serialize the new STObject into; the API also limits
-sizes of the old object and field.
+Emplacing a new field into STObject by calling [sto_emplace](https://xrpl-hooks.readme.io/reference/sto_emplace) requires enough space to serialize the new STObject into; the API also limits sizes of the old object and field.
 
-This check warns about insufficient output buffer space as well as
-too-large values of the inputs in calls to `sto_emplace` (if they're
-specified by constants - variable parameters are ignored).
+This check warns about insufficient output buffer space as well as too-large values of the inputs in calls to `sto_emplace` (if they're specified by constants - variable parameters are ignored).

xrpl-hooks-docs/md/hooks-field-buf-len.md

@@ -1,6 +1,5 @@
 # hooks-field-buf-len
 
-Hook API `sto_subfield` requires non-empty input buffer.
+Hook API [sto_subfield](https://xrpl-hooks.readme.io/reference/sto_subfield) requires non-empty input buffer.
 
-This check warns about empty input in calls to `sto_subfield` (if it's
-specified by a constant - variable parameter is ignored).
+This check warns about empty input in calls to `sto_subfield` (if it's specified by a constant - variable parameter is ignored).

xrpl-hooks-docs/md/hooks-field-del-buf-len.md

@@ -1,9 +1,5 @@
 # hooks-field-del-buf-len
 
-Erasing a field from STObject by calling `sto_erase` requires enough
-space to serialize the new STObject into; the API also limits size of
-the old object.
+Erasing a field from STObject by calling [sto_erase](https://xrpl-hooks.readme.io/reference/sto_erase) requires enough space to serialize the new STObject into; the API also limits size of the old object.
 
-This check warns about insufficient output buffer space as well as
-too-large value of the input STObject in calls to `sto_erase` (if
-they're specified by constants - variable parameters are ignored).
+This check warns about insufficient output buffer space as well as too-large value of the input STObject in calls to `sto_erase` (if they're specified by constants - variable parameters are ignored).

xrpl-hooks-docs/md/hooks-float-arith-pure.md

@@ -1,15 +1,8 @@
 # hooks-float-arith-pure
 
-Hooks can compute floating-point values in XFL format by calling
-functions `float_multiply`, `float_mulratio`, `float_negate`,
-`float_sum`, `float_invert` and `float_divide` and access their
-constituent parts by calling `float_exponent`, `float_mantissa` and
-`float_sign`. If the inputs of the computation never change, a more
-efficient way to do this is to precompute it.
+Hooks can compute floating-point values in XFL format by calling functions [float_multiply](https://xrpl-hooks.readme.io/reference/float_multiply), [float_mulratio](https://xrpl-hooks.readme.io/reference/float_mulratio), [float_negate](https://xrpl-hooks.readme.io/reference/float_negate), [float_sum](https://xrpl-hooks.readme.io/reference/float_sum), [float_invert](https://xrpl-hooks.readme.io/reference/float_invert) and [float_divide](https://xrpl-hooks.readme.io/reference/float_divide) and access their constituent parts by calling [float_exponent](https://xrpl-hooks.readme.io/reference/float_exponent), [float_mantissa](https://xrpl-hooks.readme.io/reference/float_mantissa) and [float_sign](https://xrpl-hooks.readme.io/reference/float_sign). If the inputs of the computation never change, a more efficient way to do this is to precompute it.
+
+This check warns about calls of the aforementioned functions with constant inputs and in simple cases proposes to add a tracing statement showing the computed value (so that the user can use it to replace the call). It also checks that the divisor passed to `float_divide`, `float_mulratio` and `float_invert` is not 0 (if it's specified by a constant - variable parameters are ignored).
+
+[Read more](https://xrpl-hooks.readme.io/docs/floating-point-numbers-xfl)
 
-This check warns about calls of the aforementioned functions with
-constant inputs and in simple cases proposes to add a tracing
-statement showing the computed value (so that the user can use it to
-replace the call). It also checks that the divisor passed to
-`float_divide`, `float_mulratio` and `float_invert` is not 0 (if it's
-specified by a constant - variable parameters are ignored).

xrpl-hooks-docs/md/hooks-float-compare-pure.md

@@ -1,9 +1,5 @@
 # hooks-float-compare-pure
 
-Hooks can compare floating-point values in XFL format by calling the
-`float_compare` function. If the inputs of the comparison never
-change, its result is fixed and the function need not be called.
+Hooks can compare floating-point values in XFL format by calling the [float_compare](https://xrpl-hooks.readme.io/reference/float_compare) function. If the inputs of the comparison never change, its result is fixed and the function need not be called.
 
-This check warns about calls of `float_compare` with constant inputs
-as well as invalid values of the comparison mode parameter (if it's
-specified by a constant - variable parameter is ignored).
+This check warns about calls of `float_compare` with constant inputs as well as invalid values of the comparison mode parameter (if it's specified by a constant - variable parameter is ignored).

xrpl-hooks-docs/md/hooks-float-int-pure.md

@@ -1,10 +1,5 @@
 # hooks-float-int-pure
 
-Hooks can convert floating-point values in XFL format to integers by
-calling the `float_int` function. If the inputs of this function never
-change, a more efficient way to do this is to precompute the integer
-value.
+Hooks can convert floating-point values in XFL format to integers by calling the [float_int](https://xrpl-hooks.readme.io/reference/float_int) function. If the inputs of this function never change, a more efficient way to do this is to precompute the integer value.
 
-This check warns about calls of `float_int` with constant inputs as
-well as invalid values of the decimal places parameter (if it's
-specified by a constant - variable parameter is ignored).
+This check warns about calls of `float_int` with constant inputs as well as invalid values of the decimal places parameter (if it's specified by a constant - variable parameter is ignored).

xrpl-hooks-docs/md/hooks-float-manip-pure.md

@@ -1,13 +1,5 @@
 # hooks-float-manip-pure
 
-Hooks can directly manipulate floating-point values in XFL format by
-calling functions `float_exponent_set`, `float_mantissa_set` and
-`float_sign_set`. If the inputs of the update never change, a more
-efficient way to do this is to precompute it.
+Hooks can directly manipulate floating-point values in XFL format by calling functions [float_exponent_set](https://xrpl-hooks.readme.io/reference/float_exponent_set), [float_mantissa_set](https://xrpl-hooks.readme.io/reference/float_mantissa_set) and [float_sign_set](https://xrpl-hooks.readme.io/reference/float_sign_set). If the inputs of the update never change, a more efficient way to do this is to precompute it.
 
-This check warns about calls of the aforementioned functions with
-constant inputs and in simple cases proposes to add a tracing
-statement showing the computed value (so that the user can use it to
-replace the call). It also checks documented bounds of the second
-parameter of these functions (if it's specified by a constant -
-variable parameter is ignored).
+This check warns about calls of the aforementioned functions with constant inputs and in simple cases proposes to add a tracing statement showing the computed value (so that the user can use it to replace the call). It also checks documented bounds of the second parameter of these functions (if it's specified by a constant - variable parameter is ignored).

xrpl-hooks-docs/md/hooks-float-one-pure.md

@@ -1,5 +1,3 @@
 # hooks-float-one-pure
 
-Hooks can obtain XFL enclosing number 1 by calling the float_one
-function. Since the number never changes, a more efficient way is to
-use its precomputed value.
+Hooks can obtain XFL enclosing number 1 by calling the [float_one](https://xrpl-hooks.readme.io/reference/float_one) function. Since the number never changes, a more efficient way is to use its precomputed value.

xrpl-hooks-docs/md/hooks-float-pure.md

@@ -1,12 +1,7 @@
 # hooks-float-pure
 
-Hooks can use floating-point values in XFL format, creating them from
-mantissa and exponent by calling the `float_set` function. If the
-mantissa and exponent never change, a more efficient way to do this is
-to precompute the floating-point value.
+Hooks can use floating-point values in XFL format, creating them from mantissa and exponent by calling the [float_set](https://xrpl-hooks.readme.io/reference/float_set) function. If the mantissa and exponent never change, a more efficient way to do this is to precompute the floating-point value.
 
-This check warns about calls of `float_set` with constant inputs and
-proposes to add a tracing statement showing the computed value (so
-that the user can use it to replace the call). In the special case of
-0 mantissa and 0 exponent ("canonical 0"), a replacement value of 0 is
-proposed directly, with no need to trace it.
+This check warns about calls of `float_set` with constant inputs and proposes to add a tracing statement showing the computed value (so that the user can use it to replace the call). In the special case of 0 mantissa and 0 exponent ("canonical 0"), a replacement value of 0 is proposed directly, with no need to trace it.
+
+[Read more](https://xrpl-hooks.readme.io/docs/floating-point-numbers-xfl)

xrpl-hooks-docs/md/hooks-guard-called.md

@@ -1,5 +1,5 @@
 # hooks-guard-called
 
-Every hook needs to import the guard function `_g` and use it at least once.
+Every hook needs to import the guard function [_g](https://xrpl-hooks.readme.io/docs/loops-and-guarding#the-guard-function) and use it at least once.
 
-[Read documentation](https://xrpl-hooks.readme.io/docs/loops-and-guarding)
+[Read more](https://xrpl-hooks.readme.io/docs/loops-and-guarding)

xrpl-hooks-docs/md/hooks-guard-in-for.md

@@ -1,6 +1,6 @@
 # hooks-guard-in-for
 
-Consider the following for-loop in C:
+A guard is a marker that must be placed in your code at the top of each loop. Consider the following for-loop in C:
 
 ```c
   #define GUARD(maxiter) _g(__LINE__, (maxiter)+1)
@@ -8,5 +8,7 @@ Consider the following for-loop in C:
   for (int i = 0; GUARD(3), i < 3; ++i)
 ```
 
-This is the only way to satisfy the guard rule when using a for-loop
-in C.
+<BR/>
+This is the only way to satisfy the guard rule when using a for-loop in C.
+
+[Read more](https://xrpl-hooks.readme.io/docs/loops-and-guarding)

xrpl-hooks-docs/md/hooks-guard-in-while.md

@@ -9,3 +9,6 @@ Like for loops, while loops must have a guard in their condition:
   int i = 0;
   while (GUARD(3), i < 3)
 ```
+
+<BR/>
+[Read more](https://xrpl-hooks.readme.io/docs/loops-and-guarding)

xrpl-hooks-docs/md/hooks-hash-buf-len.md

@@ -1,7 +1,5 @@
 # hooks-hash-buf-len
 
-Functions `util_sha512h`, `hook_hash`, `ledger_last_hash` and `nonce`
-have fixed-size hash output.
+Functions [util_sha512h](https://xrpl-hooks.readme.io/reference/util_sha512h), [hook_hash](https://xrpl-hooks.readme.io/reference/hook_hash), [ledger_last_hash](https://xrpl-hooks.readme.io/reference/ledger_last_hash) and [nonce](https://xrpl-hooks.readme.io/reference/nonce) have fixed-size hash output.
 
-This check warns about too-small size of their output buffer (if it's
-specified by a constant - variable parameter is ignored).
+This check warns about too-small size of their output buffer (if it's specified by a constant - variable parameter is ignored).

xrpl-hooks-docs/md/hooks-keylet-buf-len.md

@@ -1,8 +1,7 @@
 # hooks-keylet-buf-len
 
-Computing a ripple keylet by calling `util_keylet` requires valid
-parameters dependent on the keylet type.
+Computing a ripple keylet by calling [util_keylet](https://xrpl-hooks.readme.io/reference/util_keylet) requires valid parameters dependent on the keylet type.
 
-This check does not fully parse these parameters, but warns about
-invalid keylet type as well as buffer sizes that cannot be valid (if
-they're specified by constants - variable parameters are ignored).
+This check does not fully parse these parameters, but warns about invalid keylet type as well as buffer sizes that cannot be valid (if they're specified by constants - variable parameters are ignored).
+
+[Read more](https://xrpl-hooks.readme.io/docs/slots-and-keylets)

xrpl-hooks-docs/md/hooks-raddr-conv-buf-len.md

@@ -1,8 +1,5 @@
 # hooks-raddr-conv-buf-len
 
-Hook API `util_accid` has upper limit on the length of its input
-(because it expects it to be a raddr) and fixed-size account ID
-output.
+Hook API [util_accid](https://xrpl-hooks.readme.io/reference/util_accid) has upper limit on the length of its input (because it expects it to be a raddr) and fixed-size account ID output.
 
-This check warns about invalid sizes of input and output parameters
-(if they're specified by constants - variable parameters are ignored).
+This check warns about invalid sizes of input and output parameters (if they're specified by constants - variable parameters are ignored).

xrpl-hooks-docs/md/hooks-raddr-conv-pure.md

@@ -1,10 +1,5 @@
 # hooks-raddr-conv-pure
 
-Hooks identify accounts by the 20 byte account ID, which can be
-converted from a raddr using the `util_accid` function. If the raddr
-never changes, a more efficient way to do this is precompute the
-account-id from the raddr.
+Hooks identify accounts by the 20 byte account ID, which can be converted from a raddr using the [util_accid](https://xrpl-hooks.readme.io/reference/util_accid) function. If the raddr never changes, a more efficient way to do this is precompute the account-id from the raddr.
 
-This check warns about calls of `util_accid` with constant input and
-proposes to add a tracing statement showing the computed value (so
-that the user can use it to replace the call).
+This check warns about calls of `util_accid` with constant input and proposes to add a tracing statement showing the computed value (so that the user can use it to replace the call).

xrpl-hooks-docs/md/hooks-reserve-limit.md

@@ -1,9 +1,5 @@
 # hooks-reserve-limit
 
-Hook API `etxn_reserve` takes a parameter specifying the number of
-transactions intended to emit from the calling hook. Value of this
-parameter is limited, and the function fails if the limit is exceeded.
+Hook API [etxn_reserve](https://xrpl-hooks.readme.io/reference/etxn_reserve) takes a parameter specifying the number of transactions intended to emit from the calling hook. Value of this parameter is limited, and the function fails if the limit is exceeded.
 
-This check warns about too-large values of the number of reserved
-transactions (if they're specified by a constant - variable parameter
-is ignored).
+This check warns about too-large values of the number of reserved transactions (if they're specified by a constant - variable parameter is ignored).

xrpl-hooks-docs/md/hooks-slot-hash-buf-len.md

@@ -1,7 +1,5 @@
 # hooks-slot-hash-buf-len
 
-Function `slot_id` has fixed-size canonical hash output.
+Function [slot_id](https://xrpl-hooks.readme.io/reference/slot_id) has fixed-size canonical hash output.
 
-This check warns about too-small size of its output buffer as well as
-invalid values of the slot number parameter (if they're specified by
-constants - variable parameters are ignored).
+This check warns about too-small size of its output buffer as well as invalid values of the slot number parameter (if they're specified by constants - variable parameters are ignored).

xrpl-hooks-docs/md/hooks-slot-keylet-buf-len.md

@@ -1,7 +1,5 @@
 # hooks-slot-keylet-buf-len
 
-Function `slot_set` has structured keylet input.
+Function [slot_set](https://xrpl-hooks.readme.io/reference/slot_set) has structured keylet input.
 
-This check does not parse the input, but warns about its sizes that
-cannot be valid as well as invalid values of the slot number parameter
-(if they're specified by constants - variable parameters are ignored).
+This check does not parse the input, but warns about its sizes that cannot be valid as well as invalid values of the slot number parameter (if they're specified by constants - variable parameters are ignored).

xrpl-hooks-docs/md/hooks-slot-limit.md

@@ -1,9 +1,7 @@
 # hooks-slot-limit
 
-Hook APIs `slot`, `slot_count`, `slot_clear`, `slot_size`,
-`slot_float` and `trace_slot` take a parameter specifying the accessed
-slot number. Value of this parameter is limited, and the functions
-fail if the limit is exceeded.
+Hook APIs [slot](https://xrpl-hooks.readme.io/reference/slot), [slot_count](https://xrpl-hooks.readme.io/reference/slot_count), [slot_clear](https://xrpl-hooks.readme.io/reference/slot_clear), [slot_size](https://xrpl-hooks.readme.io/reference/slot_size), [slot_float](https://xrpl-hooks.readme.io/reference/slot_float) and [trace_slot](https://xrpl-hooks.readme.io/reference/trace_slot) take a parameter specifying the accessed slot number. Value of this parameter is limited, and the functions fail if the limit is exceeded.
 
-This check warns about too-large values of the slot number (if it's
-specified by a constant - variable parameter is ignored).
+This check warns about too-large values of the slot number (if it's specified by a constant - variable parameter is ignored).
+
+[Read more](https://xrpl-hooks.readme.io/docs/slots-and-keylets)

xrpl-hooks-docs/md/hooks-slot-sub-limit.md

@@ -1,8 +1,5 @@
 # hooks-slot-sub-limit
 
-Hook APIs `slot_subarray` and `slot_subfield` take parameters
-specifying parent and child slot numbers. Values of these parameters
-are limited, and the functions fail if the limit is exceeded.
+Hook APIs [slot_subarray](https://xrpl-hooks.readme.io/reference/slot_subarray) and [slot_subfield](https://xrpl-hooks.readme.io/reference/slot_subfield) take parameters specifying parent and child slot numbers. Values of these parameters are limited, and the functions fail if the limit is exceeded.
 
-This check warns about too-large values of the slot numbers (if
-they're specified by a constant - variable parameters are ignored).
+This check warns about too-large values of the slot numbers (if they're specified by a constant - variable parameters are ignored).

xrpl-hooks-docs/md/hooks-slot-type-limit.md

@@ -1,9 +1,5 @@
 # hooks-slot-type-limit
 
-Hook API `slot_type` takes a parameter specifying the accessed slot
-number. Value of this parameter is limited, and the function fails if
-the limit is exceeded.
+Hook API [slot_type](https://xrpl-hooks.readme.io/reference/slot_type) takes a parameter specifying the accessed slot number. Value of this parameter is limited, and the function fails if the limit is exceeded.
 
-This check warns about too-large values of the slot number as well as
-invalid values of the flags parameter (if they're specified by
-constants - variable parameters are ignored).
+This check warns about too-large values of the slot number as well as invalid values of the flags parameter (if they're specified by constants - variable parameters are ignored).

xrpl-hooks-docs/md/hooks-state-buf-len.md

@@ -1,6 +1,5 @@
 # hooks-state-buf-len
 
-Functions state and state_set accept fixed-size Hook State key.
+Functions [state](https://xrpl-hooks.readme.io/reference/state) and [state_set](https://xrpl-hooks.readme.io/reference/state_set) accept fixed-size Hook State key.
 
-This check warns about invalid size of its input buffer (if it's
-specified by a constant - variable parameter is ignored).
+This check warns about invalid size of its input buffer (if it's specified by a constant - variable parameter is ignored).

xrpl-hooks-docs/md/hooks-transaction-hash-buf-len.md

@@ -1,6 +1,5 @@
 # hooks-transaction-hash-buf-len
 
-Function `otxn_id` has fixed-size canonical hash output.
+Function [otxn_id](https://xrpl-hooks.readme.io/reference/otxn_id) has fixed-size canonical hash output.
 
-This check warns about too-small size of its output buffer (if it's
-specified by a constant - variable parameter is ignored).
+This check warns about too-small size of its output buffer (if it's specified by a constant - variable parameter is ignored).

xrpl-hooks-docs/md/hooks-transaction-slot-limit.md

@@ -1,8 +1,7 @@
 # hooks-transaction-slot-limit
 
-Function `otxn_slot` takes a parameter specifying the accessed slot
-number. Value of this parameter is limited, and the function fails if
-the limit is exceeded.
+Function [otxn_slot](https://xrpl-hooks.readme.io/reference/otxn_slot) takes a parameter specifying the accessed slot number. Value of this parameter is limited, and the function fails if the limit is exceeded.
 
-This check warns about too-large values of the slot number (if it's
-specified by a constant - variable parameter is ignored).
+This check warns about too-large values of the slot number (if it's specified by a constant - variable parameter is ignored).
+
+[Read more](https://xrpl-hooks.readme.io/docs/slots-and-keylets)

xrpl-hooks-docs/md/hooks-validate-buf-len.md

@@ -1,6 +1,5 @@
 # hooks-validate-buf-len
 
-Hook API `sto_validate` requires non-empty input buffer.
+Hook API [sto_validate](https://xrpl-hooks.readme.io/reference/sto_validate) requires non-empty input buffer.
 
-This check warns about empty input in calls to `sto_validate` (if it's
-specified by a constant - variable parameter is ignored).
+This check warns about empty input in calls to `sto_validate` (if it's specified by a constant - variable parameter is ignored).

xrpl-hooks-docs/md/hooks-verify-buf-len.md

@@ -1,8 +1,5 @@
 # hooks-verify-buf-len
 
-Verifying a cryptographic signature by calling `util_verify` requires
-valid public key & data signature.
+Verifying a cryptographic signature by calling [util_verify](https://xrpl-hooks.readme.io/reference/util_verify) requires valid public key & data signature.
 
-This check does not fully parse these parameters, but warns about
-their sizes that cannot be valid (if they're specified by constants -
-variable parameters are ignored).
+This check does not fully parse these parameters, but warns about their sizes that cannot be valid (if they're specified by constants - variable parameters are ignored).