Skip to content

Commit b4bf9db

Browse files
committed
Add complete TOC and stubs
1 parent 67788fb commit b4bf9db

26 files changed

+79
-3
lines changed

docs/clients/curl-client.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# CURL Client

docs/clients/guzzle5-adapter.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Guzzle5 Adapter

docs/clients/guzzle6-adapter.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Guzzle6 Adapter

docs/clients/mock-client.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Mock Client

docs/clients/react-adapter.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# React Adapter

docs/clients/socket-client.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Socket Client
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Adapter Integration Tests
2+
3+
TODO

docs/components/client-common.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Client Common
2+
3+
TODO

docs/components/message.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Message
2+
3+
This package contains various PSR-7 tools which might be useful in an HTTP workflow:
4+
5+
* Authentication method implementations
6+
* Various Stream encoding tools
7+
* Message decorators
8+
* Message factory implementations for Guzzle PSR-7 and Diactoros
9+
* Cookie implementation
10+
11+
TODO

docs/components/promise.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Promise
2+
3+
Promise used for asynchronous HTTP requests.
4+
5+
This will eventually be removed/deprecated and replaced with the upcoming Promise PSR.

docs/httplug/plugins/encoding.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/plugins/cache.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Cache Plugin
2+
3+
TODO

docs/plugins/content-length.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Content-Length Plugin
2+
3+
TODO
File renamed without changes.

docs/plugins/decoder.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Decoder Plugin
2+
3+
TODO
File renamed without changes.

docs/plugins/history.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# History Plugin
2+
3+
TODO: explain the error plugin
File renamed without changes.

docs/plugins/journal.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Journal
2+
3+
TODO

docs/plugins/logger.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Logger Plugin
2+
3+
TODO
File renamed without changes.
File renamed without changes.
File renamed without changes.

mkdocs.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,36 @@ markdown_extensions:
99
permalink: true
1010
- sane_lists
1111
- admonition
12+
13+
pages:
14+
- Home: index.md
15+
- HTTPlug:
16+
- httplug/index.md
17+
- httplug/migrating.md
18+
- 'Clients & Adapters':
19+
- clients/curl-client.md
20+
- clients/mock-client.md
21+
- clients/socket-client.md
22+
- clients/guzzle5-adapter.md
23+
- clients/guzzle6-adapter.md
24+
- clients/react-adapter.md
25+
- Plugins:
26+
- plugins/index.md
27+
- plugins/authentication.md
28+
- plugins/cache.md
29+
- plugins/content-length.md
30+
- plugins/cookie.md
31+
- plugins/decoder.md
32+
- plugins/error.md
33+
- plugins/history.md
34+
- plugins/journal.md
35+
- plugins/logger.md
36+
- plugins/redirect.md
37+
- plugins/retry.md
38+
- plugins/stopwatch.md
39+
- Other Components: components/
40+
# - components/discovery.md
41+
# - components/message.md
42+
# - components/message-factory.md
43+
# - components/promise.md
44+

0 commit comments

Comments
 (0)