Fix broken documentation links

Signed-off-by: Henrique Moody <[email protected]>
Respect · Feb 19, 2024 · 543b973 · 543b973
1 parent d8cd6a3
commit 543b973
Show file tree

Hide file tree

Showing 25 changed files with 57 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -9,9 +9,9 @@
 The most awesome validation engine ever created for PHP.
 
 - Complex rules made simple: `v::numericVal()->positive()->between(1, 255)->validate($input)`.
-- [Granularity control](docs/feature-guide.md#validation-methods) for advanced reporting.
-- [More than 150](docs/list-of-rules.md) (fully tested) validation rules.
-- [A concrete API](docs/concrete-api.md) for non fluent usage.
+- [Granularity control](docs/02-feature-guide.md#validation-methods) for advanced reporting.
+- [More than 150](docs/08-list-of-rules-by-category.md) (fully tested) validation rules.
+- [A concrete API](docs/05-concrete-api.md) for non fluent usage.
 
 Learn More:
 

diff --git a/bin/update-doc-links b/bin/update-doc-links
@@ -36,7 +36,7 @@ create_rule_documentation()
   local rule=${1}
   local related_rules=${2}
   local filename="${DOCS_DIREECTORY}/rules/${rule}.md"
-  local links=$(egrep '^\[.+\]: .+' "${filename}")
+  local links=$(ggrep -E '^\[.+\]: .+' "${filename}")
   local related_links=$(
     tr ':' '\n' <<< ${related_rules} |
       sort -u |
@@ -46,10 +46,10 @@ create_rule_documentation()
   )
 
   # "Description" section
-  sed -nE '/^# /,/^## Changelog/p' "${filename}" | egrep -v '^## Changelog'
+  sed -nE '/^# /,/^## Changelog/p' "${filename}" | ggrep -E -v '^## Changelog'
 
   # "Changelog" section
-  sed -nE '/^## Changelog/,/^\*\*\*/p' "${filename}" | fgrep -v '***'
+  sed -nE '/^## Changelog/,/^\*\*\*/p' "${filename}" | ggrep -Fv '***'
 
   # "See also" section
   echo "***"
@@ -78,7 +78,7 @@ create_list_of_rules()
 
   echo "Creating list of rules"
   {
-    echo "# List of rules"
+    echo "# List of rules by category"
     echo
     for category in $(list_categories); do
       echo "## ${category}"
@@ -91,7 +91,7 @@ create_list_of_rules()
     echo "## Alphabetically"
     echo
     ls -1 "${DOCS_DIREECTORY}/rules/" | sort | sed -E 's,^(.+).md$,- [\1](rules/\1.md),'
-  } > "${DOCS_DIREECTORY}/list-of-rules.md"
+  } > "${DOCS_DIREECTORY}/08-list-of-rules-by-category.md"
 }
 
 link_related_rules()
@@ -101,7 +101,7 @@ link_related_rules()
   echo "Building list of related rules"
   for rule in $(list_rules); do
     declare filename="${DOCS_DIREECTORY}/rules/${rule}.md"
-    declare related_rules=$(egrep '\[.+\]\(.+\.md\)' "${filename}" |
+    declare related_rules=$(ggrep -E '\[.+\]\(.+\.md\)' "${filename}" |
                               sed -E 's,.*\[.+\]\((.+)\.md\).*,\1,' |
                               grep -v 'comparable-values')
 

diff --git a/docs/08-list-of-rules-by-category.md b/docs/08-list-of-rules-by-category.md
@@ -112,16 +112,14 @@
 - [Pesel](rules/Pesel.md)
 - [Pis](rules/Pis.md)
 - [PolishIdCard](rules/PolishIdCard.md)
-
-## Integrations
-
-- [Sf](rules/Sf.md)
+- [PortugueseNif](rules/PortugueseNif.md)
 
 ## Internet
 
 - [Domain](rules/Domain.md)
 - [Email](rules/Email.md)
 - [Ip](rules/Ip.md)
+- [PublicDomainSuffix](rules/PublicDomainSuffix.md)
 - [Tld](rules/Tld.md)
 - [Url](rules/Url.md)
 - [VideoUrl](rules/VideoUrl.md)
@@ -382,17 +380,18 @@
 - [PhpLabel](rules/PhpLabel.md)
 - [Pis](rules/Pis.md)
 - [PolishIdCard](rules/PolishIdCard.md)
+- [PortugueseNif](rules/PortugueseNif.md)
 - [Positive](rules/Positive.md)
 - [PostalCode](rules/PostalCode.md)
 - [PrimeNumber](rules/PrimeNumber.md)
 - [Printable](rules/Printable.md)
+- [PublicDomainSuffix](rules/PublicDomainSuffix.md)
 - [Punct](rules/Punct.md)
 - [Readable](rules/Readable.md)
 - [Regex](rules/Regex.md)
 - [ResourceType](rules/ResourceType.md)
 - [Roman](rules/Roman.md)
 - [ScalarVal](rules/ScalarVal.md)
-- [Sf](rules/Sf.md)
 - [Size](rules/Size.md)
 - [Slug](rules/Slug.md)
 - [Sorted](rules/Sorted.md)

diff --git a/docs/index.md b/docs/index.md
@@ -3,6 +3,6 @@
 The most awesome validation engine ever created for PHP.
 
 - Complex rules made simple: `v::numericVal()->positive()->between(1, 255)->validate($input)`.
-- [Granularity control](feature-guide.md#validation-methods) for advanced reporting.
-- [More than 150](list-of-rules.md) (fully tested) validation rules.
-- [A concrete API](concrete-api.md) for non fluent usage.
+- [Granularity control](02-feature-guide.md#validation-methods) for advanced reporting.
+- [More than 150](08-list-of-rules-by-category.md) (fully tested) validation rules.
+- [A concrete API](05-concrete-api.md) for non fluent usage.
diff --git a/docs/rules/Between.md b/docs/rules/Between.md
@@ -11,7 +11,7 @@ v::intVal()->between(10, 20)->validate(20); // true
 ```
 
 Validation makes comparison easier, check out our supported
-[comparable values](../comparable-values.md).
+[comparable values](../07-comparable-values.md).
 
 Message template for this validator includes `{{minValue}}` and `{{maxValue}}`.
 

diff --git a/docs/rules/Bsn.md b/docs/rules/Bsn.md
@@ -26,3 +26,4 @@ See also:
 - [Cpf](Cpf.md)
 - [Imei](Imei.md)
 - [Nif](Nif.md)
+- [PortugueseNif](PortugueseNif.md)
diff --git a/docs/rules/Callback.md b/docs/rules/Callback.md
@@ -27,4 +27,5 @@ See also:
 
 - [Call](Call.md)
 - [CallableType](CallableType.md)
+- [DateTime](DateTime.md)
 - [FilterVar](FilterVar.md)
diff --git a/docs/rules/Cnh.md b/docs/rules/Cnh.md
@@ -28,3 +28,4 @@ See also:
 - [NfeAccessKey](NfeAccessKey.md)
 - [Nif](Nif.md)
 - [Pis](Pis.md)
+- [PortugueseNif](PortugueseNif.md)
diff --git a/docs/rules/Cnpj.md b/docs/rules/Cnpj.md
@@ -25,3 +25,4 @@ See also:
 - [NfeAccessKey](NfeAccessKey.md)
 - [Nif](Nif.md)
 - [Pis](Pis.md)
+- [PortugueseNif](PortugueseNif.md)
diff --git a/docs/rules/CountryCode.md b/docs/rules/CountryCode.md
@@ -41,6 +41,7 @@ See also:
 - [CurrencyCode](CurrencyCode.md)
 - [LanguageCode](LanguageCode.md)
 - [PostalCode](PostalCode.md)
+- [PublicDomainSuffix](PublicDomainSuffix.md)
 - [SubdivisionCode](SubdivisionCode.md)
 - [Tld](Tld.md)
 

diff --git a/docs/rules/Cpf.md b/docs/rules/Cpf.md
@@ -41,3 +41,4 @@ See also:
 - [NfeAccessKey](NfeAccessKey.md)
 - [Nif](Nif.md)
 - [Pis](Pis.md)
+- [PortugueseNif](PortugueseNif.md)
diff --git a/docs/rules/CreditCard.md b/docs/rules/CreditCard.md
@@ -58,3 +58,12 @@ See also:
 - [Luhn](Luhn.md)
 - [NoWhitespace](NoWhitespace.md)
 - [Regex](Regex.md)
+***
+See also:
+
+- [Decimal](Decimal.md)
+- [Digit](Digit.md)
+- [Iban](Iban.md)
+- [Luhn](Luhn.md)
+- [NoWhitespace](NoWhitespace.md)
+- [Regex](Regex.md)
diff --git a/docs/rules/DateTime.md b/docs/rules/DateTime.md
@@ -1,4 +1,3 @@
-
 # DateTime
 
 - `DateTime()`
@@ -72,6 +71,7 @@ v::dateTime(DateTime::RFC3339_EXTENDED)->validate($input); // false
 See also:
 
 - [Between](Between.md)
+- [Callback](Callback.md)
 - [Date](Date.md)
 - [LeapDate](LeapDate.md)
 - [LeapYear](LeapYear.md)

diff --git a/docs/rules/Domain.md b/docs/rules/Domain.md
@@ -46,6 +46,7 @@ See also:
 - [Ip](Ip.md)
 - [Json](Json.md)
 - [MacAddress](MacAddress.md)
+- [PublicDomainSuffix](PublicDomainSuffix.md)
 - [Tld](Tld.md)
 - [Url](Url.md)
 

diff --git a/docs/rules/GreaterThan.md b/docs/rules/GreaterThan.md
@@ -10,7 +10,7 @@ v::greaterThan(10)->validate(9); // false
 ```
 
 Validation makes comparison easier, check out our supported
-[comparable values](../comparable-values.md).
+[comparable values](../07-comparable-values.md).
 
 Message template for this validator includes `{{compareTo}}`.
 

diff --git a/docs/rules/Ip.md b/docs/rules/Ip.md
@@ -50,6 +50,7 @@ See also:
 
 - [Domain](Domain.md)
 - [MacAddress](MacAddress.md)
+- [PublicDomainSuffix](PublicDomainSuffix.md)
 - [Tld](Tld.md)
 
 [filter_var()]: https://php.net/filter_var
diff --git a/docs/rules/LessThan.md b/docs/rules/LessThan.md
@@ -10,7 +10,7 @@ v::lessThan(10)->validate(10); // false
 ```
 
 Validation makes comparison easier, check out our supported
-[comparable values](../comparable-values.md).
+[comparable values](../07-comparable-values.md).
 
 Message template for this validator includes `{{compareTo}}`.
 

diff --git a/docs/rules/MacAddress.md b/docs/rules/MacAddress.md
@@ -25,4 +25,5 @@ See also:
 - [Domain](Domain.md)
 - [Iban](Iban.md)
 - [Ip](Ip.md)
+- [PublicDomainSuffix](PublicDomainSuffix.md)
 - [Tld](Tld.md)
diff --git a/docs/rules/Max.md b/docs/rules/Max.md
@@ -11,7 +11,7 @@ v::max(10)->validate(11); // false
 ```
 
 Validation makes comparison easier, check out our supported
-[comparable values](../comparable-values.md).
+[comparable values](../07-comparable-values.md).
 
 Message template for this validator includes `{{compareTo}}`.
 

diff --git a/docs/rules/Min.md b/docs/rules/Min.md
@@ -11,7 +11,7 @@ v::intVal()->min(10)->validate(11); // true
 ```
 
 Validation makes comparison easier, check out our supported
-[comparable values](../comparable-values.md).
+[comparable values](../07-comparable-values.md).
 
 Message template for this validator includes `{{compareTo}}`.
 

diff --git a/docs/rules/Nif.md b/docs/rules/Nif.md
@@ -17,7 +17,7 @@ v::nif()->validate('P6437358A'); // false
 
 Version | Description
 --------|-------------
-  2.0.0 | Created
+  2.2.0 | Created
 
 ***
 See also:
@@ -26,3 +26,4 @@ See also:
 - [Cnh](Cnh.md)
 - [Cnpj](Cnpj.md)
 - [Cpf](Cpf.md)
+- [PortugueseNif](PortugueseNif.md)
diff --git a/docs/rules/PortugueseNif.md b/docs/rules/PortugueseNif.md
@@ -1,4 +1,4 @@
-# Portuguese NIF
+# PortugueseNif
 
 - `PortugueseNif()`
 
@@ -13,7 +13,17 @@ v::portugueseNif()->validate('220005245'); // false
 
 - Identifications
 
+## Changelog
+
+| Version | Description |
+| ------: | ----------- |
+|   2.2.0 | Created     |
+
 ***
 See also:
 
-- [Nif](Nif.md)
+- [Bsn](Bsn.md)
+- [Cnh](Cnh.md)
+- [Cnpj](Cnpj.md)
+- [Cpf](Cpf.md)
+- [Nif](Nif.md)
diff --git a/docs/rules/PublicDomainSuffix.md b/docs/rules/PublicDomainSuffix.md
@@ -31,9 +31,9 @@ Version | Description
 ***
 See also:
 
-- [Tld](Tld.md)
 - [CountryCode](CountryCode.md)
 - [Domain](Domain.md)
 - [Ip](Ip.md)
 - [MacAddress](MacAddress.md)
 - [SubdivisionCode](SubdivisionCode.md)
+- [Tld](Tld.md)
diff --git a/docs/rules/SubdivisionCode.md b/docs/rules/SubdivisionCode.md
@@ -33,6 +33,7 @@ See also:
 - [Nip](Nip.md)
 - [Pesel](Pesel.md)
 - [PolishIdCard](PolishIdCard.md)
+- [PublicDomainSuffix](PublicDomainSuffix.md)
 - [Tld](Tld.md)
 
 [iso-codes]: https://salsa.debian.org/iso-codes-team/iso-codes

diff --git a/docs/rules/Tld.md b/docs/rules/Tld.md
@@ -28,5 +28,5 @@ See also:
 - [Domain](Domain.md)
 - [Ip](Ip.md)
 - [MacAddress](MacAddress.md)
-- [SubdivisionCode](SubdivisionCode.md)
 - [PublicDomainSuffix](PublicDomainSuffix.md)
+- [SubdivisionCode](SubdivisionCode.md)