Skip to content

hyper63/docs

Repository files navigation

hyper Docs

The new docs for the hyper Service Framework

Getting Started

If you're using GitPod, then this is already done for you

Simply run yarn to install dependencies, then yarn dev to start the dev server.

Project Structure

The project is a standard Vitepress 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

See Contributing