encode · lovelydinosaur · Feb 26, 2025 · Feb 25, 2025
diff --git a/docs/06-about.md → docs/about.md b/docs/06-about.md → docs/about.md
@@ -2,6 +2,8 @@
 
 This work is a design proposal for an httpx 1.0 release.
 
+---
+
 ## Sponsorship
 
 We are currently seeking forward-looking investment that recognises the value of the infrastructure development on it's own merit. Sponsorships may be [made through GitHub](https://github.com/encode).
@@ -11,3 +13,8 @@ We do not offer equity, placements, or endorsments.
 ## License
 
 The rights of the author have been asserted.
+
+---
+
+<span class="link-prev">← [Networking](networking.md)</span>
+<span>&nbsp;</span>
diff --git a/docs/01-clients.md → docs/clients.md b/docs/01-clients.md → docs/clients.md
@@ -177,6 +177,6 @@ You can expand on this pattern to provide behavior such as request or response s
 
 ---
 
-<span class="link-prev">← [Quickstart](00-quickstart.md)</span>
-<span class="link-next">[HTTP Components](02-components.md) →</span>
+<span class="link-prev">← [Quickstart](quickstart.md)</span>
+<span class="link-next">[HTTP Components](components.md) →</span>
 <span>&nbsp;</span>
diff --git a/docs/02-components.md → docs/components.md b/docs/02-components.md → docs/components.md
@@ -215,6 +215,6 @@ The following methods can be used to create modified header instances...
 
 ---
 
-<span class="link-prev">← [Clients](01-clients.md)</span>
-<span class="link-next">[HTTP Content](03-content.md) →</span>
+<span class="link-prev">← [Clients](clients.md)</span>
+<span class="link-next">[HTTP Content](content.md) →</span>
 <span>&nbsp;</span>
diff --git a/docs/04-connections.md → docs/connections.md b/docs/04-connections.md → docs/connections.md
@@ -138,6 +138,6 @@ with httpx.open_connection("http://127.0.0.1:8080") as conn:
 
 ---
 
-<span class="link-prev">← [HTTP Content](03-content.md)</span>
-<span class="link-next">[Low Level Networking](05-networking.md) →</span>
+<span class="link-prev">← [HTTP Content](content.md)</span>
+<span class="link-next">[Low Level Networking](networking.md) →</span>
 <span>&nbsp;</span>
diff --git a/docs/03-content.md → docs/content.md b/docs/03-content.md → docs/content.md
@@ -152,6 +152,6 @@ Implmentations should typically set a `Content-Type` header indicating the corre
 
 ---
 
-<span class="link-prev">← [HTTP Components](02-components.md)</span>
-<span class="link-next">[Connections](04-connections.md) →</span>
+<span class="link-prev">← [HTTP Components](components.md)</span>
+<span class="link-next">[Connections](connections.md) →</span>
 <span>&nbsp;</span>
diff --git a/docs/README.md → docs/index.md b/docs/README.md → docs/index.md
@@ -8,6 +8,8 @@
 
 *The following is a design proposal and is not yet fully functional. The work is well underway, tho be aware that some parts of the codebase are still under development.*
 
+---
+
 # Background
 
 One of the core design principles informing `httpx` has been to aim to reduce the complexity of the stack.
@@ -56,16 +58,19 @@ Lets get to work...
 '<!doctype html>\n<html>\n<head>\n<title>Example Domain</title>...'
 ```
 
+---
+
 # Documentation
 
 The httpx 1.0 [design proposal](https://staging.d2pg1230p7w6nv.amplifyapp.com/) is now available.
 
-* [Quickstart](docs/00-quickstart.md)
-* [Clients](docs/01-clients.md)
-* [HTTP Components](docs/02-components.md)
-* [HTTP Content](docs/03-content.md)
-* [Connections](docs/04-connections.md)
-* [Low Level Networking](docs/05-networking.md)
+* [Quickstart](quickstart.md)
+* [Clients](clients.md)
+* [HTTP Components](components.md)
+* [HTTP Content](content.md)
+* [Connections](connections.md)
+* [Low Level Networking](networking.md)
+* [About](about.md)
 
 *Documentation & design work on `httpx` for server-side usage is in progress.*
 

diff --git a/docs/05-networking.md → docs/networking.md b/docs/05-networking.md → docs/networking.md
@@ -230,5 +230,6 @@ Custom network backends can also be used to provide functionality such as handli
 
 ---
 
-<span class="link-prev">← [Connections](04-connections.md)</span>
+<span class="link-prev">← [Connections](connections.md)</span>
+<span class="link-next">[About](about.md) →</span>
 <span>&nbsp;</span>
diff --git a/docs/00-quickstart.md → docs/quickstart.md b/docs/00-quickstart.md → docs/quickstart.md
@@ -266,5 +266,6 @@ You can stream the binary content of the response...
 
 ---
 
-<span class="link-next">[Clients](01-clients.md) →</span>
+<span class="link-prev">← [Home](index.md)</span>
+<span class="link-next">[Clients](clients.md) →</span>
 <span>&nbsp;</span>
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,14 @@
+site_name: My Docs
+
+theme:
+    name: null
+    custom_dir: 'theme/'
+
+nav:
+    - Home: index.md
+    - QuickStart: quickstart.md
+    - Clients: clients.md
+    - Components: components.md
+    - Content: content.md
+    - Networking: networking.md
+    - About: about.md
diff --git a/scripts/mkdocs b/scripts/mkdocs
diff --git a/docs/templates/base.html → theme/main.html b/docs/templates/base.html → theme/main.html
@@ -108,7 +108,7 @@
 </head>
 <body>
     <main>
-        {{ content }}
+        {{ page.content }}
     </main>
 
 </body></html>