Skip to content

Commit 05b1f89

Browse files
committed
fix(docs): refine adoption guides structure and links
1 parent 9a688b2 commit 05b1f89

6 files changed

Lines changed: 23 additions & 65 deletions

File tree

docs/_config.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,14 @@ plugins:
88

99
baseurl: "/openapi-generics"
1010

11-
just_the_docs:
12-
custom_css:
13-
- assets/css/custom.css
11+
# TOC davranışı (Home sayfa için kritik)
12+
toc:
13+
min_level: 2
14+
max_level: 2
1415

16+
# Üst sağ link
1517
aux_links:
16-
"View on GitHub":
18+
"GitHub":
1719
- "https://github.com/blueprint-platform/openapi-generics"
1820

1921
search_enabled: true

docs/adoption/client-side-adoption.md

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ layout: default
33
title: Client-Side Adoption
44
parent: Adoption Guides
55
nav_order: 2
6+
has_toc: true
7+
toc_label: "Contents"
68
---
79

810
# Client-Side Adoption — Contract-First Client Integration
@@ -29,24 +31,6 @@ It focuses on four things:
2931

3032
---
3133

32-
## 📑 Table of Contents
33-
34-
* [⚡ 60-second quick start](#-60-second-quick-start)
35-
* [🎯 What the client actually does](#-what-the-client-actually-does)
36-
* [📥 Input: OpenAPI (not your contract)](#-input-openapi-not-your-contract)
37-
* [📦 Minimal setup](#-minimal-setup)
38-
* [🧠 Progressive adoption modes (0.9.x)](#-progressive-adoption-modes-09x)
39-
* [🏗 Build pipeline (what really happens)](#-build-pipeline-what-really-happens)
40-
* [🧠 Output: what gets generated](#-output-what-gets-generated)
41-
* [🚀 Usage: how the client enters your system](#-usage-how-the-client-enters-your-system)
42-
* [🧱 Adapter boundary (strongly recommended)](#-adapter-boundary-strongly-recommended)
43-
* [🔍 Quick verification](#-quick-verification)
44-
* [⚠️ Error handling](#-error-handling)
45-
* [🧠 Mental model](#-mental-model)
46-
* [🧾 Summary](#-summary)
47-
48-
---
49-
5034
## ⚡ 60-second quick start
5135

5236
You want:

docs/adoption/server-side-adoption.md

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ layout: default
33
title: Server-Side Adoption
44
parent: Adoption Guides
55
nav_order: 1
6+
has_toc: true
7+
toc_label: "Contents"
68
---
79

810
# Server-Side Adoption — Contract-First OpenAPI Publication
@@ -16,23 +18,6 @@ The platform guarantees a **stable, generator-ready OpenAPI projection**.
1618

1719
---
1820

19-
## 📑 Table of Contents
20-
21-
* [⚡ 60-second quick start](#-60-second-quick-start)
22-
* [🎯 What the server actually does](#-what-the-server-actually-does)
23-
* [🧩 The only rule that matters](#-the-only-rule-that-matters)
24-
* [📦 Minimal dependencies](#-minimal-dependencies)
25-
* [✍️ What you actually write](#-what-you-actually-write)
26-
* [🧠 What gets published to OpenAPI](#-what-gets-published-to-openapi)
27-
* [🔁 Projection pipeline (what really happens)](#-projection-pipeline-what-really-happens)
28-
* [⚠️ Rules (do NOT break these)](#-rules-do-not-break-these)
29-
* [🔍 Quick verification](#-quick-verification)
30-
* [📦 Samples (recommended)](#-samples-recommended)
31-
* [🧠 Mental model](#-mental-model)
32-
* [🧾 Summary](#-summary)
33-
34-
---
35-
3621
## ⚡ 60-second quick start
3722

3823
You want:

docs/architecture/summary/client-code-generation.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: openapi-generics-client-side — Summary (0.9.x)
3+
nav_exclude: true
4+
---
5+
16
# openapi-generics Client Side — Summary
27

38
## What the client side is now

docs/architecture/summary/server-openapi-projection.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: openapi-generics Server Side — Summary (0.9.x)
3+
nav_exclude: true
4+
---
5+
6+
17
# openapi-generics Server Side — Summary
28

39
## What this module is now

docs/index.md

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
layout: default
33
title: Home
44
nav_order: 1
5+
has_toc: true
6+
toc_label: "Contents"
57
---
68

79
# OpenAPI Generics — Keep Your API Contract Intact End-to-End
@@ -11,32 +13,6 @@ nav_order: 1
1113
1214
---
1315

14-
## Table of Contents
15-
16-
* [Why this exists](#why-this-exists)
17-
* [What you actually do](#what-you-actually-do)
18-
* [Quick Start](#-quick-start)
19-
20-
* [1. Server (producer)](#1-server-producer)
21-
* [2. Client (consumer)](#2-client-consumer)
22-
* [Result](#result)
23-
* [Compatibility Matrix](#-compatibility-matrix)
24-
* [Proof — Generated Client (Before vs After)](#proof--generated-client-before-vs-after)
25-
26-
* [Before (default OpenAPI behavior)](#before-default-openapi-behavior)
27-
* [After (contract-aligned generation)](#after-contract-aligned-generation)
28-
* [What changed](#what-changed)
29-
* [What is actually generated](#what-is-actually-generated)
30-
* [How you actually use it](#how-you-actually-use-it)
31-
* [What this gives you](#what-this-gives-you)
32-
* [Why this matters](#why-this-matters)
33-
* [Mental model](#mental-model)
34-
* [Next steps](#next-steps)
35-
* [References & External Links](#-references--external-links)
36-
* [Final note](#final-note)
37-
38-
---
39-
4016
## Why this exists
4117

4218
In most OpenAPI-based workflows:

0 commit comments

Comments
 (0)