docs: update README and CONTRIBUTING

hyper63 · Jan 8, 2024 · e1e0ee9 · e1e0ee9
1 parent 602e298
commit e1e0ee9
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# Contributing to the Cookbook
+# Contributing to the Docs
 
 👍🎉First off, thanks for taking the time to contribute🎉👍
 
@@ -17,7 +17,7 @@ The docs are layed out in 4 different sections.
 | Build         | References and guides on how to build with hyper               |
 | Host          | Guides on how to host hyper                                    |
 
-Depending on what you are writing, it will live in one of these sections
+Depending on what you are writing, it will live in one of these sections.
 
 ### Building
 

diff --git a/README.md b/README.md
@@ -10,7 +10,22 @@ Simply run `yarn` to install dependencies, then `yarn dev` to start the dev serv
 
 ## Project Structure
 
-The project is a standard [`Vitepress`](https://vitepress.dev/) structure.
+The project is a standard [`Vitepress`](https://vitepress.dev/) site.
+
+The docs are layed out in 4 different sections, within `/docs`.
+
+| Section       | Description                                                    |
+| ------------- | -------------------------------------------------------------- |
+| Api Reference | References to the various `App` interfaces for hyper           |
+| Concepts      | Building blocks of hyper that are good to know for development |
+| Build         | References and guides on how to build with hyper               |
+| Host          | Guides on how to host hyper                                    |
+
+## Request Missing Content
+
+Missing something on the docs? This something isn't right? Think there should be another section?
+
+Please create an issue and we'll try to get it added!
 
 ## Contributing