From 72d48e3fcc2ee0bce2e1a479141cde4e7e3def66 Mon Sep 17 00:00:00 2001 From: "Jing Xu(RainX)" Date: Wed, 25 Oct 2023 21:17:27 +0800 Subject: [PATCH] docs: update README files to add API Reference link for new packages --- README.md | 3 ++- ...al-exceptions-750cd51a-cc98-405e-af90-0a155313368b.json | 7 +++++++ packages/exceptions/README.md | 2 +- 3 files changed, 10 insertions(+), 2 deletions(-) create mode 100644 change/@rightcapital-exceptions-750cd51a-cc98-405e-af90-0a155313368b.json diff --git a/README.md b/README.md index 75ae960..79bbea6 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,8 @@ This is a Mono repository contains a set of useful libraries/helpers in TypeScri it including the following packages: -- @rightcapital/exceptions: This library provides a set of standard Exceptions ([docs](https://github.com/RightCapitalHQ/frontend-libraries/tree/main/packages/exceptions/docs)) +- @rightcapital/exceptions: This library provides a set of standard Exceptions ([API Reference](https://github.com/RightCapitalHQ/frontend-libraries/tree/main/packages/exceptions/docs)) +- @rightcapital/date-helpers: A utility class providing various date formatting and parsing methods in TypeScript. ([API Reference](https://github.com/RightCapitalHQ/frontend-libraries/blob/main/packages/date-helpers/docs/modules.md)) ## Development diff --git a/change/@rightcapital-exceptions-750cd51a-cc98-405e-af90-0a155313368b.json b/change/@rightcapital-exceptions-750cd51a-cc98-405e-af90-0a155313368b.json new file mode 100644 index 0000000..422203d --- /dev/null +++ b/change/@rightcapital-exceptions-750cd51a-cc98-405e-af90-0a155313368b.json @@ -0,0 +1,7 @@ +{ + "type": "patch", + "comment": "docs: update README files to add API Reference link for new packages", + "packageName": "@rightcapital/exceptions", + "email": "i@rainx.cc", + "dependentChangeType": "patch" +} diff --git a/packages/exceptions/README.md b/packages/exceptions/README.md index 1dcdf93..b5c1dd7 100644 --- a/packages/exceptions/README.md +++ b/packages/exceptions/README.md @@ -37,6 +37,6 @@ try { } ``` -## Modules +## API Reference [Here](/packages/exceptions/docs/modules.md) is the API documentation for the modules included in the package.