Skip to content

Commit

Permalink
feat(doc): fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
krokoko committed Dec 5, 2023
1 parent 845cc56 commit 7658362
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 4 deletions.
4 changes: 2 additions & 2 deletions DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ Default output format [None]: json
```

- [Node](https://nodejs.org/en) >= v20.9.0
- [AWS CDK](https://github.com/aws/aws-cdk/releases/tag/v2.102.0) >= 2.103.1
- [AWS CDK](https://github.com/aws/aws-cdk/releases/tag/v2.102.0) >= 2.111.0
- [Python](https://www.python.org/downloads/) >=3.9
- [Projen](https://github.com/projen/projen) >= 0.73.33
- [Projen](https://github.com/projen/projen) >= 0.77.4
- [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
Expand Down
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
- [CDK Versions](#cdk-versions)
- [Contributing](#contributing)
- [Adding new constructs](#design-guidelines-and-development-guide)
- [Getting Started](#getting-started)
- [Catalog](#catalog)
- [Sample Use Cases](#sample-use-cases)
- [Operational Metrics Collection](#operational-metrics-collection)
Expand All @@ -43,6 +44,26 @@ Contributions of all kinds are welcome! Check out our [contributor guide](./CONT

If you want to add a new construct to the library, check out our [design guidelines](./DESIGN_GUIDELINES.md), then follow the [development guide](./DEVELOPER_GUIDE.md)

# Getting Started

#### For TypeScript:
- Create or use an existing CDK application in TypeScript.
- `cdk init app --language typescript`
- Run `npm install @cdklabs/generative-ai-cdk-constructs`
- The package should be added to your package.json.
- Import the library:
- `import * as genai from '@cdklabs/generative-ai-cdk-constructs';`

#### For Python:
- Create or use an existing CDK application in Python
- `cdk init app --language python`
- Install the package:
- `pip install cdklabs.generative-ai-cdk-constructs`
- Import the library:
- `import cdklabs.generative_ai_cdk_constructs`

Refer to the documentation for additional guidance on a particular construct: [Catalog](#catalog)

# Catalog

The following constructs are available in the library:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import * as os from 'aws-cdk-lib/aws-opensearchservice';
import * as cognito from 'aws-cdk-lib/aws-cognito';
import { RagApiGatewayOpensearch, RagApiGatewayOpensearchProps } from '@cdklabs/generative-ai-cdk-constructs';
import { RagAppsyncStepfnOpensearch, RagAppsyncStepfnOpensearchProps } from '@cdklabs/generative-ai-cdk-constructs';

// get an existing OpenSearch provisioned cluster in the same VPC as of RagAppsyncStepfnOpensearch construct
// Security group for the existing opensearch cluster should allow traffic on 443.
Expand Down Expand Up @@ -164,7 +164,7 @@ Parameters

- scope [Construct](https://docs.aws.amazon.com/cdk/api/v2/docs/constructs.Construct.html)
- id string
- props [RagApiGatewayOpensearchProps](../aws-rag-appsync-stepfn-opensearch/index.ts)
- props [RagAppsyncStepfnOpensearchProps](../aws-rag-appsync-stepfn-opensearch/index.ts)

## Pattern Construct Props

Expand Down

0 comments on commit 7658362

Please sign in to comment.