Skip to content

Commit dad9a44

Browse files
committed
update readme
1 parent da6f066 commit dad9a44

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ packages/
2828
│ │ └── RestApiGateway/ # API Gateway specific constructs
2929
│ ├── resources/ # AWS resource definitions
3030
│ └── stacks/ # CDK stack definitions
31+
├── sample_docs/ # Contains sample docs for testing purposes. These should not be used for real usage
3132
├── slackBotFunction/ # Lambda function for Slack bot integration
3233
│ ├── app/ # Application code
3334
│ │ ├── config/ # Configuration and environment variables
@@ -171,6 +172,7 @@ These are used to do common commands related to cdk
171172
- `git-secrets-docker-setup` Sets up git-secrets Docker container.
172173
- `pre-commit` Runs pre-commit hooks on all files.
173174
- `test` Runs unit tests for Lambda functions.
175+
- `sync-docs` Runs a script to sync sample docs to s3 bucket for a pull request. Useful for setting up a stack for testing
174176

175177
#### Compiling
176178

0 commit comments

Comments
 (0)