Skip to content

Commit e1e0ee9

Browse files
committed
docs: update README and CONTRIBUTING
1 parent 602e298 commit e1e0ee9

File tree

2 files changed

+18
-3
lines changed

2 files changed

+18
-3
lines changed

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to the Cookbook
1+
# Contributing to the Docs
22

33
👍🎉First off, thanks for taking the time to contribute🎉👍
44

@@ -17,7 +17,7 @@ The docs are layed out in 4 different sections.
1717
| Build | References and guides on how to build with hyper |
1818
| Host | Guides on how to host hyper |
1919

20-
Depending on what you are writing, it will live in one of these sections
20+
Depending on what you are writing, it will live in one of these sections.
2121

2222
### Building
2323

README.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,22 @@ Simply run `yarn` to install dependencies, then `yarn dev` to start the dev serv
1010

1111
## Project Structure
1212

13-
The project is a standard [`Vitepress`](https://vitepress.dev/) structure.
13+
The project is a standard [`Vitepress`](https://vitepress.dev/) site.
14+
15+
The docs are layed out in 4 different sections, within `/docs`.
16+
17+
| Section | Description |
18+
| ------------- | -------------------------------------------------------------- |
19+
| Api Reference | References to the various `App` interfaces for hyper |
20+
| Concepts | Building blocks of hyper that are good to know for development |
21+
| Build | References and guides on how to build with hyper |
22+
| Host | Guides on how to host hyper |
23+
24+
## Request Missing Content
25+
26+
Missing something on the docs? This something isn't right? Think there should be another section?
27+
28+
Please create an issue and we'll try to get it added!
1429

1530
## Contributing
1631

0 commit comments

Comments
 (0)