Merge branch 'docs-rewrite' of https://github.com/ZeroIntensity/view.py into docs-rewrite

Author: ZeroIntensity

CONTRIBUTING.md

@@ -8,11 +8,13 @@ If you're stuck, confused, or just don't know what to start with, our [Discord](
 
 ## Getting Started
 
-Assuming you have Git installed, simply clone the repo and install view.py locally:
+Assuming you have Git installed, simply clone the repo and install view.py locally (under a virtual environment):
 
 ```
 $ git clone https://github.com/ZeroIntensity/view.py
 $ cd view.py
+$ python3 -m venv .venv
+$ source .venv/bin/activate
 $ pip install .
 ```
 
@@ -43,9 +45,12 @@ async def index():
 app.run()
 ```
 
-Note that you do need to `pip install .` to get your changes under the `view` module. However, waiting for pip every time can be a headache. Unless you're modifying the [C API](https://github.com/ZeroIntensity/view.py/tree/master/src/_view), you don't actually need it. Instead, you can test your code via just importing from `src.view`. For example:
+Note that you do need to `pip install .` to get your changes under the `view` module. However, waiting for pip every time can be a headache. Unless you're modifying the [C API](https://github.com/ZeroIntensity/view.py/tree/master/src/_view), you don't actually need it. Instead, you can test your code via just importing from `src.view`. A `test.py` file **should not** be inside of the `src/view` folder, but instead outside it (i.e. in the same directory as `src`).
+
+For example, a simple `test.py` could look like:
 
 ```py
+# test.py
 from src.view import new_app
 
 app = new_app()
@@ -57,6 +62,8 @@ async def index():
 app.run()
 ```
 
+**Note:** Import from `view` internally *does not* work when using `src.view`. Instead, your imports inside of view.py should look like `from .foo import bar`. For example, if you wanted to import `view.routing.get` from `src/view/app.py`, your import would look like `from .routing import get`
+
 For debugging purposes, you're also going to want to disable `fancy` and `hijack` in the configuration:
 
 ```toml
@@ -65,6 +72,8 @@ fancy = false
 hijack = false
 ```
 
+These settings will stop view.py's fancy output from showing, as well as stopping the hijack of the `uvicorn` logger, and you'll get the raw `uvicorn` output.
+
 ## Writing Tests
 
 **Note:** You do need to `pip install .` to update the tests, as they import from `view` and not `src.view`.
@@ -84,7 +93,7 @@ async def _():
 
     async with app.test() as test:
         res = await test.get("/")
-        assert res.test == "test"
+        assert res.message == "test"
 ```
 
 In the above code, a server **would not** be started, and instead just virtualized for testing purposes.

README.md

@@ -1,17 +1,24 @@
 <div align="center"><img src="https://raw.githubusercontent.com/ZeroIntensity/view.py/master/html/logo.png" alt="view.py logo" width=250 height=auto /></div>
 
-## The Batteries-Detachable Web Framework
+<div align="center"><h2>The Batteries-Detachable Web Framework</h2></div>
 
 > [!Warning]
 > view.py is in very early stages and not yet considered to be ready for production.
 > If you would like to follow development progress, join [the discord](https://discord.gg/tZAfuWAbm2).
 > For contributing to view.py, please see our [CONTRIBUTING.md](https://github.com/ZeroIntensity/view.py/blob/master/CONTRIBUTING.md)
 
+<div align="center">
+    <a href="https://clientarea.space-hosting.net/aff.php?aff=303"><img width=250 height=auto src="https://cdn-dennd.nitrocdn.com/fygsTSpFNuiCdXWNTtgOTVMRlPWNnIZx/assets/images/optimized/rev-758b0f8/www.space-hosting.net/wp-content/uploads/2023/02/cropped-Icon.png"></a>
+    <h3>view.py is affiliated with <a href="https://clientarea.space-hosting.net/aff.php?aff=303">Space Hosting</a></h3>
+</div>
+
 - [Docs](https://view.zintensity.dev)
 - [Source](https://github.com/ZeroIntensity/view.py)
 - [PyPI](https://pypi.org/project/view.py)
 - [Discord](https://discord.gg/tZAfuWAbm2)
 
+## Example
+
 ```py
 from view import new_app, h1
 
@@ -24,23 +31,23 @@ async def index():
 app.run()
 ```
 
-### Installation
+## Installation
 
 **Python 3.8+ is required.**
 
-#### Development 
+### Development 
 
 ```
 $ pip install git+https://github.com/ZeroIntensity/view.py
 ```
 
-#### Linux/macOS
+### Linux/macOS
 
 ```
 $ python3 -m pip install -U view.py
 ```
 
-#### Windows
+### Windows
 
 ```
 > py -3 -m pip install -U view.py

docs/index.md

@@ -1,4 +1,4 @@
 ---
 template: home.html
 title: The Batteries-Detachable Web Framework
----
+---