Skip to content

Commit f9faf01

Browse files
committed
docs(site): add GitHub Pages config and update index.md
- Added _config.yml with Just the Docs theme and site metadata - Updated index.md homepage: clarified links, removed redundancy, improved "More Docs" section
1 parent b66cce0 commit f9faf01

File tree

4 files changed

+36
-1
lines changed

4 files changed

+36
-1
lines changed

docs/_config.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
title: Spring Boot OpenAPI Generics Clients
2+
description: Type-safe OpenAPI clients with generics (Spring Boot + OpenAPI Generator)
3+
4+
remote_theme: just-the-docs/just-the-docs
5+
6+
plugins:
7+
- jekyll-remote-theme
8+
9+
aux_links:
10+
"View on GitHub":
11+
- "https://github.com/bsayli/spring-boot-openapi-generics-clients"
12+
13+
search_enabled: true
14+
15+
baseurl: "/spring-boot-openapi-generics-clients"

docs/adoption/client-side-adoption.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
layout: default
3+
title: Client-Side Adoption
4+
parent: Adoption Guides
5+
nav_order: 2
6+
---
7+
18
# Client-Side Integration Guide
29

310
This document describes how to integrate the **generics-aware OpenAPI client** into your own microservice project, based

docs/adoption/server-side-adoption.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
layout: default
3+
title: Server-Side Adoption
4+
parent: Adoption Guides
5+
nav_order: 1
6+
---
7+
18
# Adopt the server‑side pieces in your own Spring Boot service (MVC + Springdoc)
29

310
**Purpose:** Copy the minimal set of classes/config from `customer-service` into your own microservice so that:

docs/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: default
3+
title: Home
4+
nav_order: 1
5+
---
6+
17
# Spring Boot OpenAPI Generics Clients
28

39
Welcome! 👋
@@ -31,4 +37,4 @@ Generated wrappers can be found under:
3137

3238
## 📖 More Docs
3339

34-
See the full [README on GitHub](https://github.com/bsayli/spring-boot-openapi-generics-clients#readme).
40+
See the full [README on GitHub](https://github.com/bsayli/spring-boot-openapi-generics-clients#readme).

0 commit comments

Comments
 (0)