Merge pull request #4 from ChainSafe/willem/documentation-fixes

Minor fixes to docs pages
ChainSafe · Aug 13, 2024 · ec6e2c8 · ec6e2c8
2 parents 0b95948 + 7eac690
commit ec6e2c8
Show file tree

Hide file tree

Showing 23 changed files with 71 additions and 805 deletions.
diff --git a/README.md b/README.md
@@ -6,12 +6,64 @@ A performant javascript client library for building Zcash browser wallets
 
 ## Overview
 
+WebZjs aims to make it simple to securely interact with Zcash from within the browser. This is primarily to support the development of web wallets and browser plugins. 
 
+Being a private blockchain Zcash places a lot more demands on the wallet than a public blockchain like Ethereum. WebZjs uses everything at its disposal to give efficient sync times and a good user experience.
 
-## Prerequisites
+## Usage
+
+```typescript
+// TODO
+```
+
+## Building
+
+### Prerequisites
 
 - This repo uses [just](https://github.com/casey/just) as a command runner. Please install this first.
 - Install [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/)
-- Tested with Rust nightly-2024-02-26
+- Requires clang 17 or later
+    - On Mac this can be installed by updating LLVM using your preferred package manager (e.g. macports, brew)
+- Tested with Rust nightly-2024-08-07
+
+### Building for Browser
+
+This just script uses wasm-pack to build a web-ready javascript library.
+
+```shell
+just build-web
+```
+
+After building the resulting lib can be found in `packages/webz-core`.
+
+## Development
+
+The [`.cargo/config.toml`](./.cargo/config.toml) file sets the build target to `wasm32-unknown-unknown` so the regular cargo commands (e.g. `check`, `build`) will run against this target.
+
+### Testing
+
+Tests are run in a headless browser environment and can be run with
+
+```shell
+just test-web
+```
+
+## Security Warnings
+
+These libraries are currently under development, have received no reviews or audit, and come with no guarantees whatsoever.
+
+## License
+
+All code in this workspace is licensed under either of
+
+ * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+ * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
 
+### Contribution
 
+Unless you explicitly state otherwise, any contribution intentionally
+submitted for inclusion in the work by you, as defined in the Apache-2.0
+license, shall be dual licensed as above, without any additional terms or
+conditions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,4 +1,4 @@
-# Website
+# WebZjs Doc Website
 
 This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
 
@@ -26,16 +26,4 @@ This command generates static content into the `build` directory and can be serv
 
 ### Deployment
 
-Using SSH:
-
-```
-$ USE_SSH=true yarn deploy
-```
-
-Not using SSH:
-
-```
-$ GIT_USER=<Your GitHub username> yarn deploy
-```
-
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+Deployment to Github pages is automated via a [workflow](../.github/workflows/deploy-docs.yml)
diff --git a/docs/docs/intro.md b/docs/docs/intro.md
@@ -4,44 +4,5 @@ sidebar_position: 1
 
 # Tutorial Intro
 
-Let's discover **Docusaurus in less than 5 minutes**.
+TODO!!
 
-## Getting Started
-
-Get started by **creating a new site**.
-
-Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
-
-### What you'll need
-
-- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
-  - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
-
-## Generate a new site
-
-Generate a new Docusaurus site using the **classic template**.
-
-The classic template will automatically be added to your project after you run the command:
-
-```bash
-npm init docusaurus@latest my-website classic
-```
-
-You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
-
-The command also installs all necessary dependencies you need to run Docusaurus.
-
-## Start your site
-
-Run the development server:
-
-```bash
-cd my-website
-npm run start
-```
-
-The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
-
-The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
-
-Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
diff --git a/docs/docs/tutorial-basics/_category_.json b/docs/docs/tutorial-basics/_category_.json
diff --git a/docs/docs/tutorial-basics/congratulations.md b/docs/docs/tutorial-basics/congratulations.md
diff --git a/docs/docs/tutorial-basics/create-a-blog-post.md b/docs/docs/tutorial-basics/create-a-blog-post.md
diff --git a/docs/docs/tutorial-basics/create-a-document.md b/docs/docs/tutorial-basics/create-a-document.md
diff --git a/docs/docs/tutorial-basics/create-a-page.md b/docs/docs/tutorial-basics/create-a-page.md
diff --git a/docs/docs/tutorial-basics/deploy-your-site.md b/docs/docs/tutorial-basics/deploy-your-site.md