Skip to content

Commit b66cce0

Browse files
committed
docs: add GitHub Pages landing page (docs/index.md)
- Includes quick links to server/client adoption guides - Adds Quick Start and “where to find generated wrappers” - Lightweight landing page for GitHub Pages
1 parent f6157a3 commit b66cce0

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

docs/index.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Spring Boot OpenAPI Generics Clients
2+
3+
Welcome! 👋
4+
5+
This site is generated from the [`spring-boot-openapi-generics-clients`](https://github.com/bsayli/spring-boot-openapi-generics-clients) repository.
6+
7+
---
8+
9+
## 📘 Adoption Guides
10+
11+
* [Server-Side Adoption](adoption/server-side-adoption.md)
12+
* [Client-Side Adoption](adoption/client-side-adoption.md)
13+
14+
---
15+
16+
## 🚀 Quick Start
17+
18+
```bash
19+
cd customer-service
20+
mvn spring-boot:run
21+
22+
cd ../customer-service-client
23+
mvn clean install
24+
```
25+
26+
Generated wrappers can be found under:
27+
28+
`target/generated-sources/openapi/src/gen/java`
29+
30+
---
31+
32+
## 📖 More Docs
33+
34+
See the full [README on GitHub](https://github.com/bsayli/spring-boot-openapi-generics-clients#readme).

0 commit comments

Comments
 (0)