Skip to content

Commit 5938dee

Browse files
docs(bulk-cdk): Add API documentation links to README and CONTRIBUTING (#69811)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
1 parent f923809 commit 5938dee

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

airbyte-cdk/bulk/CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ sdk default java 21.0.9-zulu
2929

3030
The Kotlin Bulk CDK uses [Dokka](https://kotlinlang.org/docs/dokka-introduction.html) to generate API documentation from KDoc comments.
3131

32-
### Generate Documentation
32+
**Published Documentation**: The latest API documentation is available at https://airbyte-kotlin-cdk.vercel.app/
33+
34+
### Generate Documentation Locally
3335

3436
```bash
3537
./gradlew :airbyte-cdk:bulk:docsGenerate

airbyte-cdk/bulk/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ The Bulk CDK is the "new java CDK" that's currently incubating.
44
As the name suggests, its purpose is to help develop connectors which extract or load data in bulk.
55
The Bulk CDK is written in Kotlin and uses the Micronaut framework for dependency injection.
66

7-
**Contributing**: See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, building, testing, and documentation generation instructions.
7+
- **API Reference Docs**: [Kotlin CDK API Reference](https://airbyte-kotlin-cdk.vercel.app/)
8+
- **Contributing**: See [CONTRIBUTING.md](CONTRIBUTING.md).
89

910
## Structure
1011

0 commit comments

Comments
 (0)