Skip to content

Commit bb4db2e

Browse files
committed
Added a preliminary guide skeleton and introduction
1 parent 229a0d1 commit bb4db2e

File tree

8 files changed

+24
-5
lines changed

8 files changed

+24
-5
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,8 @@ Here is a checklist that all Gloo utility crates should fulfill:
126126

127127
* [ ] Crate's root module documentation has at least one realistic example.
128128

129+
* [ ] Crate has at least a brief description of how to use it in the Gloo guide.
130+
129131
[unwrap-throw]: https://docs.rs/wasm-bindgen/0.2.37/wasm_bindgen/trait.UnwrapThrowExt.html
130132
[api-guidelines]: https://rust-lang-nursery.github.io/api-guidelines/
131133

guide/book.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[book]
2-
authors = ["David O'Connor"]
2+
authors = ["rustwasm"]
33
multilingual = false
44
src = "src"
55
title = "Gloo Guide"

guide/src/SUMMARY.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Summary
1+
# The Gloo Guide
22

3-
- [About](./about.md)
3+
- [Introduction](./introduction.md)
4+
- [Using Gloo crates](./using-gloo.md)
45
- [Timers](./timers.md)
6+
- [Console-timer](./console-timer.md)

guide/src/about.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

guide/src/console-timer.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
## Console Timer

guide/src/introduction.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Introduction
2+
3+
Welcome to the Gloo Guide, an introductory guide about [Gloo](https://github.com/rustwasm/gloo).
4+
Gloo is a toolkit for building web applications and libraries with Rust and Wasm, composed of
5+
modular crates. [Gloo crates](https://github.com/rustwasm/gloo/tree/master/crates)
6+
include example code, both in their respective `example` folders, and commented in their code, as well
7+
as [API documentation](https://docs.rs/gloo/). The purpose of this guide is to complement these
8+
by providing narritive description,
9+
and step-by-step of how to use Gloo and its crates.
10+
11+
This guide assumes familiarity with the [Rust language](https://www.rust-lang.org/), and web programming.
12+
If you'd like to learn Rust,
13+
check out the [Rust Book](https://doc.rust-lang.org/book/index.html). The [MDN web docs](https://developer.mozilla.org/en-US/)
14+
is a good reference for web programming.

guide/src/timers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# Chapter 1
1+
## Timers

guide/src/using-gloo.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
## Using Gloo crates

0 commit comments

Comments
 (0)