Merge pull request #7 from public-awesome/fair-burn-contract-docs

Improve crate docs for fair burn contract

Author: shanev

.cargo/config

@@ -2,4 +2,5 @@
 wasm = "build --lib --release --target wasm32-unknown-unknown"
 wasm-debug = "build --target wasm32-unknown-unknown"
 unit-test = "test --lib -- --nocapture"
-lint = "clippy -- -D warnings"
+lint = "clippy -- -D warnings"
+e2e-test = "test --package e2e-tests -- --nocapture --ignored --test-threads 1 -Z unstable-options --report-time"

.github/workflows/basic.yml

@@ -63,6 +63,12 @@ jobs:
           override: true
           components: rustfmt, clippy
 
+      - name: Run cargo doc
+        uses: actions-rs/cargo@v1
+        with:
+          command: doc
+          args: -F library
+
       - name: Run cargo fmt
         uses: actions-rs/cargo@v1
         with:

.gitignore

@@ -1,6 +1,7 @@
 # Build results
 /target
 /schema
+/artifacts
 
 # Cargo+Git helper file (https://github.com/rust-lang/cargo/blob/0.44.1/src/cargo/sources/git/utils.rs#L320-L327)
 .cargo-ok