docs: revise the links of current API docs

README.md

@@ -109,4 +109,4 @@ We don't need to run the `publish` command locally.
 - https://pnpm.io/workspaces
 - https://microsoft.github.io/beachball/
 - https://commitizen-tools.github.io/commitizen/
-- https://www.conventionalcommits.org/zh-hans/v1.0.0/#%e7%ba%a6%e5%ae%9a%e5%bc%8f%e6%8f%90%e4%ba%a4%e8%a7%84%e8%8c%83
+- https://www.conventionalcommits.org/

change/@rightcapital-exceptions-3507ae5a-1631-4d5e-856e-c607092a9031.json

@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "docs: revise the links of current API docs",
+  "packageName": "@rightcapital/exceptions",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

packages/exceptions/README.md

@@ -36,3 +36,7 @@ try {
   }
 }
 ```
+
+## Modules
+
+[Here](/packages/exceptions/docs/modules.md) is the API documentation for the modules included in the package.

packages/exceptions/docs/README.md

@@ -38,3 +38,7 @@ try {
   }
 }
 ```
+
+## Modules 
+
+[Here](/packages/exceptions/docs/modules.md) is the API documentation for the modules included in the package.

packages/exceptions/docs/classes/BadFunctionCallException.md

@@ -48,7 +48,7 @@ Exception thrown if a callback refers to an undefined function or if some argume
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14)
+[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14)
 
 ## Properties
 
@@ -64,7 +64,7 @@ The value of cause can be of any type. You should not make assumptions that the
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16)
+[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16)
 
 ___
 
@@ -92,7 +92,7 @@ ___
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/bad-function-call.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/bad-function-call.exception.ts#L8)
+[packages/exceptions/src/exceptions/bad-function-call.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/bad-function-call.exception.ts#L8)
 
 ___
 
@@ -134,4 +134,4 @@ true if the cause we passed is the original cause when the Exception constructed
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27)
+[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27)

packages/exceptions/docs/classes/BadMethodCallException.md

@@ -46,7 +46,7 @@ Exception thrown if a callback refers to an undefined method or if some argument
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14)
+[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14)
 
 ## Properties
 
@@ -62,7 +62,7 @@ The value of cause can be of any type. You should not make assumptions that the
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16)
+[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16)
 
 ___
 
@@ -90,7 +90,7 @@ ___
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/bad-method-call.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/bad-method-call.exception.ts#L8)
+[packages/exceptions/src/exceptions/bad-method-call.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/bad-method-call.exception.ts#L8)
 
 ___
 
@@ -132,4 +132,4 @@ true if the cause we passed is the original cause when the Exception constructed
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27)
+[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27)

packages/exceptions/docs/classes/BaseException.md

@@ -60,7 +60,7 @@ Error.constructor
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14)
+[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14)
 
 ## Properties
 
@@ -72,7 +72,7 @@ The value of cause can be of any type. You should not make assumptions that the
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16)
+[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16)
 
 ___
 
@@ -138,4 +138,4 @@ true if the cause we passed is the original cause when the Exception constructed
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27)
+[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27)

packages/exceptions/docs/classes/DomainException.md

@@ -46,7 +46,7 @@ Exception thrown if a value does not adhere to a defined valid data domain.
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14)
+[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14)
 
 ## Properties
 
@@ -62,7 +62,7 @@ The value of cause can be of any type. You should not make assumptions that the
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16)
+[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16)
 
 ___
 
@@ -90,7 +90,7 @@ ___
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/domain.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/domain.exception.ts#L8)
+[packages/exceptions/src/exceptions/domain.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/domain.exception.ts#L8)
 
 ___
 
@@ -132,4 +132,4 @@ true if the cause we passed is the original cause when the Exception constructed
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27)
+[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27)

packages/exceptions/docs/classes/IgnorableException.md

@@ -46,7 +46,7 @@ This Exception could be ignore
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14)
+[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14)
 
 ## Properties
 
@@ -62,7 +62,7 @@ The value of cause can be of any type. You should not make assumptions that the
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16)
+[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16)
 
 ___
 
@@ -90,7 +90,7 @@ ___
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/ignorable.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/ignorable.exception.ts#L8)
+[packages/exceptions/src/exceptions/ignorable.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/ignorable.exception.ts#L8)
 
 ___
 
@@ -132,4 +132,4 @@ true if the cause we passed is the original cause when the Exception constructed
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27)
+[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27)

packages/exceptions/docs/classes/InvalidArgumentException.md

@@ -46,7 +46,7 @@ Exception thrown if an argument is not of the expected type.
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14)
+[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14)
 
 ## Properties
 
@@ -62,7 +62,7 @@ The value of cause can be of any type. You should not make assumptions that the
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16)
+[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16)
 
 ___
 
@@ -90,7 +90,7 @@ ___
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/invalid-argument.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/invalid-argument.exception.ts#L8)
+[packages/exceptions/src/exceptions/invalid-argument.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/invalid-argument.exception.ts#L8)
 
 ___
 
@@ -132,4 +132,4 @@ true if the cause we passed is the original cause when the Exception constructed
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27)
+[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27)

packages/exceptions/docs/classes/LengthException.md

@@ -46,7 +46,7 @@ Exception thrown if a length is invalid.
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14)
+[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14)
 
 ## Properties
 
@@ -62,7 +62,7 @@ The value of cause can be of any type. You should not make assumptions that the
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16)
+[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16)
 
 ___
 
@@ -90,7 +90,7 @@ ___
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/length.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/length.exception.ts#L8)
+[packages/exceptions/src/exceptions/length.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/length.exception.ts#L8)
 
 ___
 
@@ -132,4 +132,4 @@ true if the cause we passed is the original cause when the Exception constructed
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27)
+[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27)

packages/exceptions/docs/classes/LogicException.md

@@ -56,7 +56,7 @@ Exception that represents error in the program logic. This kind of exception sho
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14)
+[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14)
 
 ## Properties
 
@@ -72,7 +72,7 @@ The value of cause can be of any type. You should not make assumptions that the
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16)
+[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16)
 
 ___
 
@@ -100,7 +100,7 @@ ___
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/logic.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/logic.exception.ts#L8)
+[packages/exceptions/src/exceptions/logic.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/logic.exception.ts#L8)
 
 ___
 
@@ -142,4 +142,4 @@ true if the cause we passed is the original cause when the Exception constructed
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27)
+[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27)

packages/exceptions/docs/classes/OutOfBoundsException.md

@@ -46,7 +46,7 @@ Exception thrown if a value is not a valid key. This represents errors that cann
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14)
+[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14)
 
 ## Properties
 
@@ -62,7 +62,7 @@ The value of cause can be of any type. You should not make assumptions that the
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16)
+[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16)
 
 ___
 
@@ -90,7 +90,7 @@ ___
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/out-of-bounds.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/out-of-bounds.exception.ts#L8)
+[packages/exceptions/src/exceptions/out-of-bounds.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/out-of-bounds.exception.ts#L8)
 
 ___
 
@@ -132,4 +132,4 @@ true if the cause we passed is the original cause when the Exception constructed
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27)
+[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27)

packages/exceptions/docs/classes/OutOfRangeException.md

@@ -46,7 +46,7 @@ Exception thrown when an illegal index was requested. This represents errors tha
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14)
+[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14)
 
 ## Properties
 
@@ -62,7 +62,7 @@ The value of cause can be of any type. You should not make assumptions that the
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16)
+[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16)
 
 ___
 
@@ -90,7 +90,7 @@ ___
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/out-of-range.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/out-of-range.exception.ts#L8)
+[packages/exceptions/src/exceptions/out-of-range.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/out-of-range.exception.ts#L8)
 
 ___
 
@@ -132,4 +132,4 @@ true if the cause we passed is the original cause when the Exception constructed
 
 #### Defined in
 
-[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27)
+[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27)