Skip to content

Commit e17174a

Browse files
committed
docs(site): refine index.md homepage layout
- cleaned up front matter format - improved Quick Start with clearer commands - added GitHub badge and direct README reference - ensured Adoption Guides are properly linked
1 parent 0bf07fd commit e17174a

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

docs/index.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
---
2+
23
layout: default
34
title: Home
45
nav_order: 1
5-
---
6+
------------
67

78
# Spring Boot OpenAPI Generics Clients
89

910
Welcome! 👋
1011

11-
This site is generated from the [
12-
`spring-boot-openapi-generics-clients`](https://github.com/bsayli/spring-boot-openapi-generics-clients) repository.
12+
This site is generated from the
13+
[`spring-boot-openapi-generics-clients`](https://github.com/bsayli/spring-boot-openapi-generics-clients) repository.
1314

1415
---
1516

@@ -23,11 +24,11 @@ This site is generated from the [
2324
## 🚀 Quick Start
2425

2526
```bash
26-
cd customer-service
27-
mvn spring-boot:run
27+
# Run the sample server
28+
cd customer-service && mvn spring-boot:run
2829

29-
cd ../customer-service-client
30-
mvn clean install
30+
# Generate and build the client
31+
cd ../customer-service-client && mvn clean install
3132
```
3233

3334
Generated wrappers can be found under:
@@ -38,4 +39,6 @@ Generated wrappers can be found under:
3839

3940
## 📖 More Docs
4041

41-
See the full [README on GitHub](https://github.com/bsayli/spring-boot-openapi-generics-clients#readme).
42+
[![View on GitHub](https://img.shields.io/badge/GitHub-View%20Repo-blue?logo=github)](https://github.com/bsayli/spring-boot-openapi-generics-clients)
43+
44+
See the full [README on GitHub](https://github.com/bsayli/spring-boot-openapi-generics-clients#readme).

0 commit comments

Comments
 (0)