Skip to content

Commit c1c3e7d

Browse files
Neaten up docs (#112)
* Neaten up docs * Hiya
1 parent 475aa32 commit c1c3e7d

File tree

4 files changed

+18
-45
lines changed

4 files changed

+18
-45
lines changed

README.md

Lines changed: 13 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@
66

77
---
88

9-
*The following is a [design proposal](https://www.encode.io/httpnext/) and is not yet complete. The work is well underway, tho be aware that some parts of the codebase are still under development.*
10-
11-
---
12-
139
A complete HTTP framework for Python.
1410

1511
*Installation...*
@@ -51,35 +47,26 @@ Serving on http://127.0.0.1:8080/ (Press CTRL+C to quit)
5147

5248
The [HTTPX 1.0 design proposal](https://www.encode.io/httpnext/) is now available.
5349

54-
* [Quickstart](https://www.encode.io/httpnext/quickstart.md)
55-
* [Clients](https://www.encode.io/httpnext/clients.md)
56-
* [Servers](https://www.encode.io/httpnext/servers.md)
57-
* [Requests](https://www.encode.io/httpnext/requests.md)
58-
* [Responses](https://www.encode.io/httpnext/responses.md)
59-
* [URLs](https://www.encode.io/httpnext/urls.md)
60-
* [Headers](https://www.encode.io/httpnext/headers.md)
61-
* [Content Types](https://www.encode.io/httpnext/content-types.md)
62-
* [Connections](https://www.encode.io/httpnext/connections.md)
63-
* [Network Backends](https://www.encode.io/httpnext/networking.md)
50+
* [Quickstart](https://www.encode.io/httpnext/quickstart)
51+
* [Clients](https://www.encode.io/httpnext/clients)
52+
* [Servers](https://www.encode.io/httpnext/servers)
53+
* [Requests](https://www.encode.io/httpnext/requests)
54+
* [Responses](https://www.encode.io/httpnext/responses)
55+
* [URLs](https://www.encode.io/httpnext/urls)
56+
* [Headers](https://www.encode.io/httpnext/headers)
57+
* [Content Types](https://www.encode.io/httpnext/content-types)
58+
* [Connections](https://www.encode.io/httpnext/connections)
59+
* [Network Backends](https://www.encode.io/httpnext/networking)
6460

6561
---
6662

6763
# Collaboration
6864

69-
The design repository for this work is currently private. We are looking towards a development model that encourages a calm focused working environment, and are currently taking a little time to work through expectations & boundaries for contributions to the codebase.
70-
71-
---
72-
73-
## Background
74-
75-
If you've been working with 0.x versions of HTTPX you'll notice significant API differences.
76-
77-
Version 1.0 provides a much more tightly constrained API. It has a lighter installation footprint, far more obvious type annotations, and a lower overall complexity.
65+
The repository for this project is currently private.
7866

79-
For example:
67+
We’re looking at creating paid opportunities for working on open source software *which are properly compensated, flexible & well balanced.*
8068

81-
* Client code [before](https://github.com/encode/httpx/blob/master/httpx/_client.py) and [after](https://github.com/encode/httpnext/blob/dev/src/httpx/_client.py).
82-
* Response code [before](https://github.com/encode/httpx/blob/master/httpx/_models.py#L515) and [after](https://github.com/encode/httpnext/blob/dev/src/httpx/_response.py).
69+
If you're interested in a position working on this project, please <a href="mailto:kim@encode.io">send an intro</a>.
8370

8471
---
8572

docs/about.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# About
22

3-
This work is a design proposal for an httpx 1.0 release.
3+
This work is a design proposal for an `httpx` 1.0 release.
44

55
---
66

@@ -16,5 +16,4 @@ The rights of the author have been asserted.
1616

1717
---
1818

19-
<span class="link-prev">← [Networking](networking.md)</span>
20-
<span>&nbsp;</span>
19+
<p align="center"><i><a href="https://www.encode.io/httpnext">home</a><i></p>

docs/index.md

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -78,17 +78,6 @@ Serving on http://127.0.0.1:8080/ (Press CTRL+C to quit)
7878

7979
---
8080

81-
Some things HTTPX supports...
82-
83-
* Use it as an HTTP client, to interact with the web.
84-
* Use it as an HTTP server, to create web APIs, applications, or websites.
85-
* Use it as a general purpose toolkit, for working with URLs, query parameters & forms.
86-
* Use it to build networking components, such as proxies.
87-
88-
Components provided by HTTPX are immutable by default, and provide tightly typed interfaces. The package has a light installation footprint & minimal stdlib imports.
89-
90-
---
91-
9281
# Documentation
9382

9483
* [Quickstart](quickstart.md)
@@ -101,18 +90,17 @@ Components provided by HTTPX are immutable by default, and provide tightly typed
10190
* [Content Types](content-types.md)
10291
* [Connections](connections.md)
10392
* [Network Backends](networking.md)
104-
* [About](about.md)
10593

10694
---
10795

10896
# Collaboration
10997

11098
The repository for this project is currently private.
11199

112-
We’re looking at creating paid opportunities for working on open source software which are properly compensated, flexible & well balanced.
100+
We’re looking at creating paid opportunities for working on open source software *which are properly compensated, flexible & well balanced.*
113101

114-
If you're interested in collaborating, <a href="mailto:kim@encode.io">send an intro</a>.
102+
If you're interested in a position working on this project, please send an intro: `kim`&nbsp;&#x40;&nbsp;`encode.io`.
115103

116104
---
117105

118-
<p align="center"><i>This design work is <a href="https://www.encode.io/httpnext/about/">not yet licensed</a> for reuse.</i><br/>&mdash; 🦋 &mdash;</p>
106+
<p align="center"><i>This design work is <a href="https://www.encode.io/httpnext/about">not yet licensed</a> for reuse.</i><br/>&mdash; 🦋 &mdash;</p>

docs/networking.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -378,5 +378,4 @@ Custom network backends can also be used to provide functionality such as handli
378378
---
379379

380380
<span class="link-prev">← [Connections](connections.md)</span>
381-
<span class="link-next">[About](about.md) →</span>
382381
<span>&nbsp;</span>

0 commit comments

Comments
 (0)