From b6140095c86527457b436ee8f287d80bcc2a5133 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Frank=20Br=C3=BCckner?= Date: Wed, 4 Dec 2024 09:06:25 +0100 Subject: [PATCH] Refactor navigation and headings for clarity MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Simplified the navigation structure in mkdocs.yml and revised document headings for better consistency and readability. The changes improve how the HTTP client sections are organized and presented in the documentation, facilitating easier navigation and comprehension for users. Signed-off-by: Frank Brückner --- docs/book/client/adapters.md | 2 +- docs/book/client/advanced.md | 2 +- docs/book/client/intro.md | 2 +- docs/book/client/static.md | 2 +- docs/book/request.md | 2 +- docs/book/response.md | 2 +- mkdocs.yml | 19 +++++++++---------- 7 files changed, 15 insertions(+), 16 deletions(-) diff --git a/docs/book/client/adapters.md b/docs/book/client/adapters.md index 8c4acadc..2693941f 100644 --- a/docs/book/client/adapters.md +++ b/docs/book/client/adapters.md @@ -1,4 +1,4 @@ -# HTTP Client Connection Adapters +# Connection Adapters `Laminas\Http\Client` is based on a connection adapter design. The connection adapter is the object in charge of performing the actual connection to the server, as well as writing requests and reading diff --git a/docs/book/client/advanced.md b/docs/book/client/advanced.md index 1beec7f5..165a7f67 100644 --- a/docs/book/client/advanced.md +++ b/docs/book/client/advanced.md @@ -1,4 +1,4 @@ -# HTTP Client Advanced Usage +# Advanced Usage ## HTTP redirections diff --git a/docs/book/client/intro.md b/docs/book/client/intro.md index 9f92ad94..9f880d8a 100644 --- a/docs/book/client/intro.md +++ b/docs/book/client/intro.md @@ -1,4 +1,4 @@ -# HTTP Client +# Introduction `Laminas\Http\Client` provides an interface for performing Hyper-Text Transfer Protocol (HTTP) requests. `Laminas\Http\Client` supports all basic features diff --git a/docs/book/client/static.md b/docs/book/client/static.md index f833157c..71d944d0 100644 --- a/docs/book/client/static.md +++ b/docs/book/client/static.md @@ -1,4 +1,4 @@ -# HTTP Client - Static Usage +# Static Usage laminas-http provides another client implementation, `Laminas\Http\ClientStatic`, a static HTTP client which exposes a simplified API for quickly performing one-off `GET` diff --git a/docs/book/request.md b/docs/book/request.md index e391a013..6ef98661 100644 --- a/docs/book/request.md +++ b/docs/book/request.md @@ -1,4 +1,4 @@ -# The Request Class +# Request `Laminas\Http\Request` is responsible for providing a fluent API that allows a developer to interact with all the various parts of an HTTP request. diff --git a/docs/book/response.md b/docs/book/response.md index 241ad9e5..16a563f1 100644 --- a/docs/book/response.md +++ b/docs/book/response.md @@ -1,4 +1,4 @@ -# The Response Class +# Response `Laminas\Http\Response` is responsible for providing a fluent API that allows a developer to interact with all the various parts of an HTTP response. diff --git a/mkdocs.yml b/mkdocs.yml index 9f9a1e64..943b1057 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,16 +3,15 @@ site_dir: docs/html nav: - Home: index.md - Introduction: intro.md - - Reference: - - Request: request.md - - Response: response.md - - Headers: headers.md - - Client: - - Intro: client/intro.md - - Adapters: client/adapters.md - - "Static Client": client/static.md - - "Cookie Persistence": client/cookies.md - - Advanced: client/advanced.md + - Request: request.md + - Response: response.md + - Headers: headers.md + - "HTTP Client": + - Introduction: client/intro.md + - "Connection Adapters": client/adapters.md + - "Static Usage": client/static.md + - "Client Cookies": client/cookies.md + - "Advanced Usage": client/advanced.md site_name: laminas-http site_description: HTTP message and header abstractions, and HTTP client implementation. (Not a PSR-7 implementation; see Diactoros for PSR-7 support. repo_url: 'https://github.com/laminas/laminas-http'