-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
13 changed files
with
102 additions
and
113 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,79 +1,59 @@ | ||
# Summary | ||
|
||
# Getting Started | ||
|
||
- [Quick Start](./quick-start.md) | ||
- [Introduction](./intro.md) | ||
- [Identity System](./identity_system.md) | ||
- [Design Philosophy](./design_philosophy.md) | ||
- [Installation](./install.md) | ||
- [Join the Network](./login.md) | ||
|
||
# System Components | ||
|
||
- [Processes](./process/processes.md) | ||
- [Capability-Based Security](./process/capabilities.md) | ||
- [Startup, Spindown, and Crashes](./process/startup.md) | ||
- [Extensions](./process/extensions.md) | ||
- [Networking Protocol](./networking_protocol.md) | ||
- [Public Key Infrastructure](./pki.md) | ||
- [HTTP Server & Client](./http_server_and_client.md) | ||
- [Files](./files.md) | ||
- [Databases](./databases.md) | ||
- [Terminal](./terminal.md) | ||
|
||
# Process Standard Library | ||
|
||
- [Overview](./process_stdlib/overview.md) | ||
|
||
# Kit: Development Tool**kit** | ||
|
||
- [`kit`](./kit/kit.md) | ||
- [`boot-fake-node`](./kit/boot-fake-node.md) | ||
- [`new`](./kit/new.md) | ||
- [`build`](./kit/build.md) | ||
- [`start-package`](./kit/start-package.md) | ||
- [`remove-package`](./kit/remove-package.md) | ||
- [`dev-ui`](./kit/dev-ui.md) | ||
- [`inject-message`](./kit/inject-message.md) | ||
- [`run-tests`](./kit/run-tests.md) | ||
|
||
# Tutorial: Build and Deploy an App | ||
|
||
- [Environment Setup](./my_first_app/chapter_1.md) | ||
- [Sending Some Messages, Using Some Tools](./my_first_app/chapter_2.md) | ||
- [Defining Your Protocol](./my_first_app/chapter_3.md) | ||
- [Frontend Time](./my_first_app/chapter_4.md) | ||
- [Sharing with the World](./my_first_app/chapter_5.md) | ||
|
||
# In-Depth Guide: Chess App | ||
|
||
- [Chess Engine](./chess_app/chess_engine.md) | ||
- [Adding a Frontend](./chess_app/frontend.md) | ||
- [Putting Everything Together](./chess_app/putting_everything_together.md) | ||
- [Extension 1: Chat](./chess_app/chat.md) | ||
|
||
# Cookbook (Handy Recipes) | ||
|
||
- [Cookbook Overview](./cookbook/cookbook_overview.md) | ||
- [Managing Child Processes](./cookbook/manage_child_processes.md) | ||
- [Publishing a Website or Web App](./cookbook/publish_to_web.md) | ||
- [Simple File Transfer Guide](./cookbook/file_transfer.md) | ||
- [Intro to Web UI with File Transfer](./cookbook/file_transfer_ui.md) | ||
- [Writing and Running Scripts](./cookbook/writing_scripts.md) | ||
- [Writing an Extension](./cookbook/extensions.md) | ||
|
||
# API Reference | ||
|
||
- [APIs Overview](./apis/overview.md) | ||
- [HTTP API](./apis/http_authentication.md) | ||
- [HTTP Client API](./apis/http_client.md) | ||
- [HTTP Server API](./apis/http_server.md) | ||
- [Kernel API](./apis/kernel.md) | ||
- [KV API](./apis/kv.md) | ||
- [Net API](./apis/net.md) | ||
- [`kinode.wit`](./apis/kinode_wit.md) | ||
- [SQLite API](./apis/sqlite.md) | ||
- [Terminal API](./apis/terminal.md) | ||
- [VFS API](./apis/vfs.md) | ||
- [WebSocket API](./apis/websocket_authentication.md) | ||
- [Getting Started](./quick-start.md) | ||
- [Introduction](./intro.md) | ||
- [Identity System](./identity_system.md) | ||
- [Design Philosophy](./design_philosophy.md) | ||
- [Installation](./install.md) | ||
- [Join the Network](./login.md) | ||
- [System Components](./system-components.md) | ||
- [Processes](./process/processes.md) | ||
- [Capability-Based Security](./process/capabilities.md) | ||
- [Startup, Spindown, and Crashes](./process/startup.md) | ||
- [Extensions](./process/extensions.md) | ||
- [Networking Protocol](./networking_protocol.md) | ||
- [Public Key Infrastructure](./pki.md) | ||
- [HTTP Server & Client](./http_server_and_client.md) | ||
- [Files](./files.md) | ||
- [Databases](./databases.md) | ||
- [Terminal](./terminal.md) | ||
- [Process Standard Library](./process_stdlib/overview.md) | ||
- [Kit: Development Tool**kit**](./kit-dev-toolkit.md) | ||
- [`boot-fake-node`](./kit/boot-fake-node.md) | ||
- [`new`](./kit/new.md) | ||
- [`build`](./kit/build.md) | ||
- [`start-package`](./kit/start-package.md) | ||
- [`remove-package`](./kit/remove-package.md) | ||
- [`dev-ui`](./kit/dev-ui.md) | ||
- [`inject-message`](./kit/inject-message.md) | ||
- [`run-tests`](./kit/run-tests.md) | ||
- [Tutorial: Build and Deploy an App](./build-and-deploy-an-app.md) | ||
- [Environment Setup](./my_first_app/chapter_1.md) | ||
- [Sending Some Messages, Using Some Tools](./my_first_app/chapter_2.md) | ||
- [Defining Your Protocol](./my_first_app/chapter_3.md) | ||
- [Frontend Time](./my_first_app/chapter_4.md) | ||
- [Sharing with the World](./my_first_app/chapter_5.md) | ||
- [In-Depth Guide: Chess App](./chess_app.md) | ||
- [Chess Engine](./chess_app/chess_engine.md) | ||
- [Adding a Frontend](./chess_app/frontend.md) | ||
- [Putting Everything Together](./chess_app/putting_everything_together.md) | ||
- [Extension 1: Chat](./chess_app/chat.md) | ||
- [Cookbook (Handy Recipes)](./cookbook.md) | ||
- [Managing Child Processes](./cookbook/manage_child_processes.md) | ||
- [Publishing a Website or Web App](./cookbook/publish_to_web.md) | ||
- [Simple File Transfer Guide](./cookbook/file_transfer.md) | ||
- [Intro to Web UI with File Transfer](./cookbook/file_transfer_ui.md) | ||
- [Writing and Running Scripts](./cookbook/writing_scripts.md) | ||
- [Writing an Extension](./cookbook/extensions.md) | ||
- [API Reference](./api_reference.md) | ||
- [HTTP API](./apis/http_authentication.md) | ||
- [HTTP Client API](./apis/http_client.md) | ||
- [HTTP Server API](./apis/http_server.md) | ||
- [Kernel API](./apis/kernel.md) | ||
- [KV API](./apis/kv.md) | ||
- [Net API](./apis/net.md) | ||
- [`kinode.wit`](./apis/kinode_wit.md) | ||
- [SQLite API](./apis/sqlite.md) | ||
- [Terminal API](./apis/terminal.md) | ||
- [VFS API](./apis/vfs.md) | ||
- [WebSocket API](./apis/websocket_authentication.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# APIs Overview | ||
|
||
The APIs documented in this section refer to Kinode runtime modules. | ||
Specifically, they are the patterns of Requests and Responses that an app can use to interact with these modules. | ||
|
||
**Note: App developers usually should not use these APIs directly. | ||
Most standard use-cases are better served by using functions in the [Process Standard Library](../process_stdlib/overview.md).** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +0,0 @@ | ||
# APIs Overview | ||
|
||
The APIs documented in this section refer to Kinode runtime modules. | ||
Specifically, they are the patterns of Requests and Responses that an app can use to interact with these modules. | ||
|
||
**Note: App developers usually should not use these APIs directly. | ||
Most standard use-cases are better served by using functions in the [Process Standard Library](../process_stdlib/overview.md).** | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Tutorial: Build and Deploy an App | ||
|
||
Welcome! | ||
In these tutorials, you'll setup your development environment and learn about the `kit` tools. | ||
You'll learn about templates and also walk through writing an application from the group up, backend and frontend. | ||
And finally, you'll learn how to deploy applications through the Kinode app store. | ||
|
||
For the purposes of this documentation, terminal commands are provided as-is for ease of copying EXCEPT when the output of the command is also shown. | ||
In that case, the command is prepended with a `$ ` to distinguish the command from the output. | ||
The `$ ` should not be copied into the terminal. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# In-Depth Guide: Chess App | ||
|
||
This guide will walk you through building a very simple chess app on Kinode OS. | ||
The final result will look like [this](https://github.com/kinode-dao/kinode/tree/main/modules/chess): chess is in the basic runtime distribution so you can try it yourself. | ||
|
||
To prepare for this tutorial, follow the environment setup guide [here](../my_first_app/chapter_1.md), i.e. [start a fake node](../my_first_app/chapter_1.md#booting-a-fake-kinode-node) and then, in another terminal, run: | ||
```bash | ||
kit new my_chess | ||
cd my_chess | ||
kit build | ||
kit start-package -p 8080 | ||
``` | ||
|
||
Once you have the template app installed and can see it running on your testing node, continue... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Getting Started | ||
|
||
This guide will help you get started with Kinode OS. It will walk you through the installation process, and provide an overview of the system's design philosophy and identity system. |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# System Components | ||
|
||
This section describes the various components of the system, including the processes, networking protocol, public key infrastructure, HTTP server and client, files, databases, and terminal. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -268,3 +268,8 @@ kbd { | |
.result-no-output { | ||
font-style: italic; | ||
} | ||
|
||
.chapter > .chapter-item a { | ||
color: var(--fg); | ||
opacity: 1; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters