Skip to content

Commit

Permalink
Update book
Browse files Browse the repository at this point in the history
  • Loading branch information
Romero027 committed Mar 27, 2024
1 parent 7b844fb commit 1a35d3c
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 16 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
book
.vscode
.DS_Store
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
# ADN Documentation
# AppNet Documentation

## Quick Start
1. Install mdbook:
```
```bash
# You need to install Rust first
cargo install mdbook
```

2. Work on your documentation while having an http server for it on
localhost:3000, rebuilding on change.
```
```bash
mdbook serve
```

<!-- 3. Build the book and open a browser to view the result:
3. Build the book and open a browser to view the result:
```
mdbook build -o
``` -->
```
2 changes: 1 addition & 1 deletion book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ authors = ["Xiangfeng Zhu"]
language = "en"
multilingual = false
src = "src"
title = "ADN Documentation"
title = "AppNet Documentation"

[output.html]
site-url = "/"
2 changes: 1 addition & 1 deletion src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
- [Introduction](introduction.md)
- [Installation](install.md)
- [Getting Started](start.md)
- [ADN Tutorials](tutorials/outline.md)
- [AppNet Tutorials](tutorials/outline.md)
- [Chain](tutorials/chain.md)
- [Element](tutorials/element.md)
- [Developer's Guide](developer.md)
Expand Down
12 changes: 6 additions & 6 deletions src/install.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# Installation Guide

Welcome to the ADN installation guide. This document provides step-by-step instructions on how to set up ADN and its dependencies.
Welcome to the AppNet installation guide. This document provides step-by-step instructions on how to set up AppNet and its dependencies.

Requirements:
- [Kubernetes](#kubernetes) (v1.28+)
- [Istio](#installing-adnistio) (v1.20+)
- [Istio](#istio) (v1.20+)
- [Python](#python) (v3.10+)
- [Go](#go) (v1.19+)
- [Rust](#rust) (v1.71+)
- [protoc](#protoc)


First, clone the ADN repo:
First, clone the AppNet repo:
```bash
git clone [email protected]:UWNetworksLab/adn-controller.git
cd adn-controller
git clone [email protected]:appnet-org/controller.git --recursive
cd controller
```

### Install the CLI

`adnctl` is a command line program to manage the ADN control plane.
`adnctl` is a command line program to manage the AppNet control plane.

To install the CLI, run
```bash
Expand Down
6 changes: 3 additions & 3 deletions src/introduction.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Introduction to ADN Project
# Introduction to AppNet Project


## What is ADN
ADN aims to enable expressive, easy-to-build, and high-performance application networks.
## What is AppNet
AppNet aims to enable expressive, easy-to-build, and high-performance application networks.

Details are available in our [HotNets paper](https://xzhu27.me/papers/adn-hotnets2023.pdf) and [talk](https://www.youtube.com/watch?v=hJobLIq1Bmk)

Expand Down

0 comments on commit 1a35d3c

Please sign in to comment.