chore(rosetta): final documentation compilation automation update (#1173)

Author: krokoko

DEVELOPER_GUIDE.md

@@ -15,10 +15,10 @@ Default region name [None]: us-east-1
 Default output format [None]: json
 ```
 
-- [Node](https://nodejs.org/en) >= v20.9.0
+- [Node](https://nodejs.org/en) >= v22.0.0
 - [AWS CDK](https://github.com/aws/aws-cdk/releases/tag/v2.219.0) >= 2.219.0
 - [Python](https://www.python.org/downloads/) >=3.9
-- [Projen](https://github.com/projen/projen) >= 0.91.5
+- [Projen](https://github.com/projen/projen/releases/tag/v0.98.0) >= 0.98.0
 - [Yarn](https://classic.yarnpkg.com/lang/en/docs/cli/install/) >= 1.22.19
 
 You can use the command below to install the dependencies listed above
@@ -128,6 +128,10 @@ Navigate to the [Generative AI CDK Construct Repository] (https://github.com/aws
 
 ## Project structure
 
+For each new pattern, ensure:
+- that you export it from the main [index.ts](./src/index.ts) file as a named export to avoid name collisions and ensure that the underlying tools can process correctly the documentation
+- have a single main README.md
+
 ```
 .
 |--docs/ (draw.io project containing architecture diagrams for all constructs)

DOCUMENTATION_TESTING.md

@@ -56,7 +56,7 @@ typescript fixture=default
 Run the documentation verification:
 
 ```bash
-yarn docs:compile
+projen docs:compile
 ```
 
 This will:

README.md

@@ -135,9 +135,9 @@ The following constructs are available in the library:
 
 | **Construct** |Description| AWS Services used |
 |:-------------|:-------------|:-------------|
-| [SageMaker model deployment (JumpStart)](./src/patterns/gen-ai/aws-model-deployment-sagemaker/README_jumpstart.md) | Deploy a foundation model from Amazon SageMaker JumpStart to an Amazon SageMaker endpoint. | Amazon SageMaker |
-| [SageMaker model deployment (Hugging Face)](./src/patterns/gen-ai/aws-model-deployment-sagemaker/README_hugging_face.md) | Deploy a foundation model from Hugging Face to an Amazon SageMaker endpoint. | Amazon SageMaker |
-| [SageMaker model deployment (Custom)](./src/patterns/gen-ai/aws-model-deployment-sagemaker/README_custom_sagemaker_endpoint.md) | Deploy a foundation model from an S3 location to an Amazon SageMaker endpoint. | Amazon SageMaker |
+| [SageMaker model deployment (JumpStart)](./src/patterns/gen-ai/aws-model-deployment-sagemaker/README.md) | Deploy a foundation model from Amazon SageMaker JumpStart to an Amazon SageMaker endpoint. | Amazon SageMaker |
+| [SageMaker model deployment (Hugging Face)](./src/patterns/gen-ai/aws-model-deployment-sagemaker/README.md) | Deploy a foundation model from Hugging Face to an Amazon SageMaker endpoint. | Amazon SageMaker |
+| [SageMaker model deployment (Custom)](./src/patterns/gen-ai/aws-model-deployment-sagemaker/README.md) | Deploy a foundation model from an S3 location to an Amazon SageMaker endpoint. | Amazon SageMaker |
 | [Amazon Bedrock Monitoring (Amazon CloudWatch Dashboard)](./src/patterns/gen-ai/aws-bedrock-cw-dashboard/README.md) | Amazon CloudWatch dashboard to monitor model usage from Amazon Bedrock. | Amazon CloudWatch |
 | [Bedrock Data Automation](./src/patterns/gen-ai/aws-bedrock-data-automation/README.md) | Use Amazon bedrock data automation client to to build and manage intelligent document processing, media analysis, and other multimodal data-centric automation solutions | AWS Lambda, Amazon S3 bucket |
 | [Bedrock Batch Step Functions](./src/patterns/gen-ai/aws-bedrock-batch-stepfn/README.md) | Manage Bedrock model invocation jobs(batch inference) in AWS Step Functions state machines | AWS Step Functions, AWS Lambda, AWS EventBridge, Amazon Bedrock, AWS IAM |

apidocs/@cdklabs/namespaces/aosscwdashboard/README.md

@@ -0,0 +1,17 @@
+[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md)
+
+***
+
+[@cdklabs/generative-ai-cdk-constructs](../../../README.md) / aosscwdashboard
+
+# aosscwdashboard
+
+## Classes
+
+- [AossCwDashboard](classes/AossCwDashboard.md)
+
+## Interfaces
+
+- [AossCwDashboardProps](interfaces/AossCwDashboardProps.md)
+- [CollectionMonitoringProps](interfaces/CollectionMonitoringProps.md)
+- [IndexMonitoringProps](interfaces/IndexMonitoringProps.md)

apidocs/classes/AossCwDashboard.md renamed to apidocs/@cdklabs/namespaces/aosscwdashboard/classes/AossCwDashboard.md

@@ -1,8 +1,8 @@
-[**@cdklabs/generative-ai-cdk-constructs**](../README.md)
+[**@cdklabs/generative-ai-cdk-constructs**](../../../../README.md)
 
 ***
 
-[@cdklabs/generative-ai-cdk-constructs](../README.md) / AossCwDashboard
+[@cdklabs/generative-ai-cdk-constructs](../../../../README.md) / [aosscwdashboard](../README.md) / AossCwDashboard
 
 # Class: AossCwDashboard
 

apidocs/interfaces/AossCwDashboardProps.md renamed to apidocs/@cdklabs/namespaces/aosscwdashboard/interfaces/AossCwDashboardProps.md

@@ -1,8 +1,8 @@
-[**@cdklabs/generative-ai-cdk-constructs**](../README.md)
+[**@cdklabs/generative-ai-cdk-constructs**](../../../../README.md)
 
 ***
 
-[@cdklabs/generative-ai-cdk-constructs](../README.md) / AossCwDashboardProps
+[@cdklabs/generative-ai-cdk-constructs](../../../../README.md) / [aosscwdashboard](../README.md) / AossCwDashboardProps
 
 # Interface: AossCwDashboardProps
 

apidocs/interfaces/CollectionMonitoringProps.md renamed to apidocs/@cdklabs/namespaces/aosscwdashboard/interfaces/CollectionMonitoringProps.md

@@ -1,8 +1,8 @@
-[**@cdklabs/generative-ai-cdk-constructs**](../README.md)
+[**@cdklabs/generative-ai-cdk-constructs**](../../../../README.md)
 
 ***
 
-[@cdklabs/generative-ai-cdk-constructs](../README.md) / CollectionMonitoringProps
+[@cdklabs/generative-ai-cdk-constructs](../../../../README.md) / [aosscwdashboard](../README.md) / CollectionMonitoringProps
 
 # Interface: CollectionMonitoringProps
 

apidocs/interfaces/IndexMonitoringProps.md renamed to apidocs/@cdklabs/namespaces/aosscwdashboard/interfaces/IndexMonitoringProps.md

@@ -1,8 +1,8 @@
-[**@cdklabs/generative-ai-cdk-constructs**](../README.md)
+[**@cdklabs/generative-ai-cdk-constructs**](../../../../README.md)
 
 ***
 
-[@cdklabs/generative-ai-cdk-constructs](../README.md) / IndexMonitoringProps
+[@cdklabs/generative-ai-cdk-constructs](../../../../README.md) / [aosscwdashboard](../README.md) / IndexMonitoringProps
 
 # Interface: IndexMonitoringProps
 

apidocs/@cdklabs/namespaces/bda/README.md

@@ -0,0 +1,15 @@
+[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md)
+
+***
+
+[@cdklabs/generative-ai-cdk-constructs](../../../README.md) / bda
+
+# bda
+
+## Classes
+
+- [BedrockDataAutomation](classes/BedrockDataAutomation.md)
+
+## Interfaces
+
+- [BedrockDataAutomationProps](interfaces/BedrockDataAutomationProps.md)

apidocs/classes/BedrockDataAutomation.md renamed to apidocs/@cdklabs/namespaces/bda/classes/BedrockDataAutomation.md

@@ -1,16 +1,16 @@
-[**@cdklabs/generative-ai-cdk-constructs**](../README.md)
+[**@cdklabs/generative-ai-cdk-constructs**](../../../../README.md)
 
 ***
 
-[@cdklabs/generative-ai-cdk-constructs](../README.md) / BedrockDataAutomation
+[@cdklabs/generative-ai-cdk-constructs](../../../../README.md) / [bda](../README.md) / BedrockDataAutomation
 
 # Class: BedrockDataAutomation
 
 Class to create a BDA pattern with CDK.
 
 ## Extends
 
-- [`BaseClass`](BaseClass.md)
+- [`BaseClass`](../../../../classes/BaseClass.md)
 
 ## Constructors
 
@@ -38,7 +38,7 @@ Class to create a BDA pattern with CDK.
 
 #### Overrides
 
-[`BaseClass`](BaseClass.md).[`constructor`](BaseClass.md#constructor)
+[`BaseClass`](../../../../classes/BaseClass.md).[`constructor`](../../../../classes/BaseClass.md#constructor)
 
 ## Properties
 
@@ -118,7 +118,7 @@ construct usage metric , added in template description
 
 #### Inherited from
 
-[`BaseClass`](BaseClass.md).[`constructUsageMetric`](BaseClass.md#constructusagemetric)
+[`BaseClass`](../../../../classes/BaseClass.md).[`constructUsageMetric`](../../../../classes/BaseClass.md#constructusagemetric)
 
 ***
 
@@ -136,7 +136,7 @@ enable disable xray tracing
 
 #### Inherited from
 
-[`BaseClass`](BaseClass.md).[`enablexray`](BaseClass.md#enablexray)
+[`BaseClass`](../../../../classes/BaseClass.md).[`enablexray`](../../../../classes/BaseClass.md#enablexray)
 
 ***
 
@@ -148,7 +148,7 @@ Default  log config for all constructs
 
 #### Inherited from
 
-[`BaseClass`](BaseClass.md).[`fieldLogLevel`](BaseClass.md#fieldloglevel)
+[`BaseClass`](../../../../classes/BaseClass.md).[`fieldLogLevel`](../../../../classes/BaseClass.md#fieldloglevel)
 
 ***
 
@@ -166,7 +166,7 @@ enable disable lambda tracing
 
 #### Inherited from
 
-[`BaseClass`](BaseClass.md).[`lambdaTracing`](BaseClass.md#lambdatracing)
+[`BaseClass`](../../../../classes/BaseClass.md).[`lambdaTracing`](../../../../classes/BaseClass.md#lambdatracing)
 
 ***
 
@@ -178,7 +178,7 @@ The tree node.
 
 #### Inherited from
 
-[`BaseClass`](BaseClass.md).[`node`](BaseClass.md#node)
+[`BaseClass`](../../../../classes/BaseClass.md).[`node`](../../../../classes/BaseClass.md#node)
 
 ***
 
@@ -198,7 +198,7 @@ Default  log retention config for all constructs
 
 #### Inherited from
 
-[`BaseClass`](BaseClass.md).[`retention`](BaseClass.md#retention)
+[`BaseClass`](../../../../classes/BaseClass.md).[`retention`](../../../../classes/BaseClass.md#retention)
 
 ***
 
@@ -216,7 +216,7 @@ Value will be appended to resources name.
 
 #### Inherited from
 
-[`BaseClass`](BaseClass.md).[`stage`](BaseClass.md#stage)
+[`BaseClass`](../../../../classes/BaseClass.md).[`stage`](../../../../classes/BaseClass.md#stage)
 
 ***
 
@@ -228,7 +228,7 @@ Record<string, number> , maps construct name with number of deployments
 
 #### Inherited from
 
-[`BaseClass`](BaseClass.md).[`usageMetricMap`](BaseClass.md#usagemetricmap)
+[`BaseClass`](../../../../classes/BaseClass.md).[`usageMetricMap`](../../../../classes/BaseClass.md#usagemetricmap)
 
 ## Methods
 
@@ -240,15 +240,15 @@ Record<string, number> , maps construct name with number of deployments
 
 ##### props
 
-[`BaseClassProps`](../interfaces/BaseClassProps.md)
+[`BaseClassProps`](../../../../interfaces/BaseClassProps.md)
 
 #### Returns
 
 `void`
 
 #### Inherited from
 
-[`BaseClass`](BaseClass.md).[`addObservabilityToConstruct`](BaseClass.md#addobservabilitytoconstruct)
+[`BaseClass`](../../../../classes/BaseClass.md).[`addObservabilityToConstruct`](../../../../classes/BaseClass.md#addobservabilitytoconstruct)
 
 ***
 
@@ -264,7 +264,7 @@ Returns a string representation of this construct.
 
 #### Inherited from
 
-[`BaseClass`](BaseClass.md).[`toString`](BaseClass.md#tostring)
+[`BaseClass`](../../../../classes/BaseClass.md).[`toString`](../../../../classes/BaseClass.md#tostring)
 
 ***
 
@@ -276,7 +276,7 @@ Returns a string representation of this construct.
 
 ##### props
 
-[`BaseClassProps`](../interfaces/BaseClassProps.md)
+[`BaseClassProps`](../../../../interfaces/BaseClassProps.md)
 
 ##### scope
 
@@ -292,7 +292,7 @@ Returns a string representation of this construct.
 
 #### Inherited from
 
-[`BaseClass`](BaseClass.md).[`updateConstructUsageMetricCode`](BaseClass.md#updateconstructusagemetriccode)
+[`BaseClass`](../../../../classes/BaseClass.md).[`updateConstructUsageMetricCode`](../../../../classes/BaseClass.md#updateconstructusagemetriccode)
 
 ***
 
@@ -304,15 +304,15 @@ Returns a string representation of this construct.
 
 ##### props
 
-[`BaseClassProps`](../interfaces/BaseClassProps.md)
+[`BaseClassProps`](../../../../interfaces/BaseClassProps.md)
 
 #### Returns
 
 `void`
 
 #### Inherited from
 
-[`BaseClass`](BaseClass.md).[`updateEnvSuffix`](BaseClass.md#updateenvsuffix)
+[`BaseClass`](../../../../classes/BaseClass.md).[`updateEnvSuffix`](../../../../classes/BaseClass.md#updateenvsuffix)
 
 ***
 
@@ -352,4 +352,4 @@ true if `x` is an object created from a class which extends `Construct`.
 
 #### Inherited from
 
-[`BaseClass`](BaseClass.md).[`isConstruct`](BaseClass.md#isconstruct)
+[`BaseClass`](../../../../classes/BaseClass.md).[`isConstruct`](../../../../classes/BaseClass.md#isconstruct)