Skip to content

Commit 16bd523

Browse files
author
luigi
committed
fix
1 parent 46fed3f commit 16bd523

File tree

1 file changed

+6
-7
lines changed
  • codegen/smithy-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/service

1 file changed

+6
-7
lines changed

codegen/smithy-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/service/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,13 @@
22

33
## Overview
44

5-
---
6-
75
This project generate **service-side code** from Smithy models, producing **complete service stubs**, including routing, serialization/deserialization, authentication, and validation, so developers can focus entirely on implementing business logic.
86

97
While Ktor is the default backend, the architecture is framework-agnostic, allowing future support for other server frameworks.
108

119

1210
## Getting Started
1311

14-
---
15-
1612
- Get an [introduction to Smithy](https://smithy.io/2.0/index.html)
1713
- Follow [Smithy's quickstart guide](https://smithy.io/2.0/quickstart.html)
1814
- See the [Guide](docs/GettingStarted.md) to learn how to use SKSC to generate service.
@@ -21,8 +17,6 @@ While Ktor is the default backend, the architecture is framework-agnostic, allow
2117

2218
## Development
2319

24-
---
25-
2620
### Module Structure
2721

2822
- `constraints` – directory that contains the constraints validation generator.
@@ -41,4 +35,9 @@ While Ktor is the default backend, the architecture is framework-agnostic, allow
4135
The **service code generation tests** are located in `tests/codegen/service-codegen-tests`. These end-to-end tests generate the service, launch the server, send HTTP requests to validate functionality, and then shut down the service once testing is complete. This process typically takes around 2 minutes. To run tests specifically for SKSC, use the following command:
4236
```bash
4337
./gradlew :tests:codegen:service-codegen-tests:test
44-
```
38+
```
39+
40+
## Feedback
41+
42+
You can provide feedback or report a bug by submitting an [issue](https://github.com/smithy-lang/smithy-kotlin/issues/new/choose).
43+
This is the preferred mechanism to give feedback so that other users can engage in the conversation, +1 issues, etc.

0 commit comments

Comments
 (0)