Skip to content

Commit 4636c9a

Browse files
authored
Merge pull request #45 from David-OConnor/docs
Guide skeleton
2 parents 47142b6 + f691d5d commit 4636c9a

8 files changed

+32
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
/target
22
**/*.rs.bk
33
Cargo.lock
4+
5+
guide/book

CONTRIBUTING.md

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

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

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

guide/book.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[book]
2+
authors = ["The Rust and WebAssembly Working Group"]
3+
multilingual = false
4+
src = "src"
5+
title = "Gloo Guide"

guide/src/SUMMARY.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# The Gloo Guide
2+
3+
- [Introduction](./introduction.md)
4+
- [Using Gloo crates](./using-gloo.md)
5+
- [Timers](./timers.md)
6+
- [Console-timer](./console-timer.md)

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 & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +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)