Merge branch 'main' into add/what-are-programs-summary

Author: johnnymatthews

.github/ISSUE_TEMPLATE

@@ -1,21 +1,20 @@
-<!-- Before submitting an issue, please review the project documentation and search for existing issues. The more details you provide, the easier it will be to diagnose and address the issue. Remove this line before submitting your issue. -->
+<!-- Describe the issue you're encountering in detail. -->
 
-Describe the issue you're encountering in detail.
+## Steps to reproduce
 
-**Issue type**: (Select one)
+<!-- Provide a step-by-step explanation of how to reproduce the issue, including the page or section URL (if relevant). -->
 
-- [ ] Bug
-- [ ] Question
-- [ ] Improvement
+## Error messages and/or screenshots
 
-**Steps to reproduce**:
+<!-- Include any relevant error messages, logs, or screenshots. -->
 
-Provide a step-by-step explanation of how to reproduce the issue.
+## Proposed solution (optional)
 
-**Error messages**:
+<!-- If you have ideas about how this might be fixed, share them here. -->
 
-Include any relevant error messages, logs, or screenshots.
+## Checklist
 
-**Expected behavior**: 
+I confirm that I have:
 
-What were you expecting to happen? This may seem like a silly question, but please be specific.
+- [ ] Checked to see if there are any existing issue that cover this topic.
+- [ ] Linked to any relevant issues across all [entropyxyz](https://github.com/entropyxyz/) repos.

.github/PULL_REQUEST_TEMPLATE

@@ -0,0 +1,24 @@
+<!-- Fill out this template to help us review your pull request. Delete any comments once you are done. -->
+
+## Description
+
+<!-- Quickly describe the changes you made and why you made them. -->
+<!-- Reference the issue/issues that this PR fixes. -->
+
+<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
+<!-- ALL PRs MUST CLOSE AN ISSUE. IF AN ISSUE DOES NOT EXIST, GO MAKE ONE. -->
+<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
+
+### Content updates
+
+<!-- List which pages or sections you have created/updated/deleted in this PR. -->
+
+## Documentation updates
+
+<!-- Have you changed how shortcodes work or how the docs site is rendered? Update the relevant info in this project's `README.md` and/or `CONTRIBUTING.md` files. -->
+
+## Checklist:
+
+- [ ] I have read and followed the `CONTRIBUTING.md` guidelines.
+- [ ] I have run these changes through a grammar and spell checker.
+- [ ] I have updated the documentation (`README.md`, `CONTRIBUTING.md` etc.) to reflect these changes.

CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Welcome Contributors
+
+We welcome contributions from developers of all experience levels. Whether you're a seasoned blockchain expert or a curious newcomer, your input is valuable to our project.
+
+## Table of contents
+
+- [Creating PRs](#creating-prs)
+- [Writing the docs](#writing-the-docs)
+
+## Creating PRs
+
+Follow these steps to make a successful and impactful PR!
+
+### Prerequisites
+
+- Familiarize yourself with the docs project by reading the `README.md`.
+- Ensure you have the necessary development tools installed.
+- Set up a local development environment following the instructions in `README.md`. The Hugo static site generator is available for pretty much every modern OS.
+
+### Fork the repository
+
+1. Create a personal fork of this project on GitHub.
+1. Clone your **forked** repository to your local machine.
+
+### Create a branch
+
+1. Create a new branch for your contribution.
+1. Use a clear, descriptive branch name that reflects the purpose of your changes, like `feat/add-key-generation-method` or `update/signature-signing-error`
+
+### Make Your Changes
+
+1. Add or update documentation as needed.
+1. Test your changes locally using Hugo to ensure the site renders correctly.
+
+### Prepare your PR
+
+1. Write clear, concise commit messages.
+1. Describe _exactly_ what the commit does. For example: "Clarifies T of N signature verification method."
+1. Run your markdown through a grammar and spell checker.
+1. Ensure clarity and correctness of all written content.
+1. If modifying technical documentation, verify technical accuracy.
+
+### Submit a Pull Request
+
+1. Push your changes to your fork.
+1. Open a pull request against this repo.
+1. Provide a clear description of your changes using the PR template provided (you'll see it when you make your PR).
+1. Link all related issues. All PRs **must** close at least one existing issue.
+
+### Code Review Process
+
+1. All pull requests will undergo a thorough code review.
+1. Reviewers will provide constructive feedback.
+1. Be prepared to make modifications based on review comments.
+
+## Writing the docs
+
+You can find all the docs in the `/content` folder. This content directory is structured the same as the website. The only caveats:
+
+1. The `docs.entropy.xyz` homepage is controlled by `./content/_index.md`.
+1. Section indexes, like `docs.entropy.xyz/concepts`, are automatically generated by Hugo -- you do not need to directly edit the content of these pages. The content in the sub-pages controls the page snippets in these index pages. For example, the snippet for the **Quickstart** entry in `docs.entropy.xyz/basics` is generated from the `lead` variable within `./content/basics/quickstart.md`. If a `lead` variable does not exist, Hugo generates a snippet from the main content of a sub-page.
+
+---
+
+**Thanks for helping improve our docs!**

README.md

@@ -123,7 +123,7 @@ To submit a support ticket:
 
 ## Contribute
 
-We appreciate contributions of any size from everyone, from fixing typos to proposing substantial rewrites to aid clarity. Simply make a PR with your edits, and a member of the Entropy devrel team will review everything.
+We appreciate contributions of any size from everyone, from fixing typos to proposing substantial rewrites to aid clarity. Take a look at the [`CONTRIBUTING.md` doc for more details](./CONTRIBUTING.md) on how to help.
 
 ### Writing docs
 

content/guides/spin-up-a-devnet.md

@@ -13,7 +13,7 @@ A devnet is an essential tool for devs working with Entropy. It provides a safe
 This guide will cover two primary methods for setting up a local Entropy devnet:
 
 - [Using Docker containers]({{< relref "#docker-containers" >}}): The recommended method for most users due to its ease of use and simplicity.
-- [Building from source]({{< relref "building-from-source" >}}): For developers who require more control or are unable to use Docker. 
+- [Building from source]({{< relref "#building-from-source" >}}): For developers who require more control or are unable to use Docker. 
 
 ## Docker containers
 

content/reference/command-line-interface/_index.md

@@ -0,0 +1,6 @@
+---
+title: "CLI"
+lead: "The command-line interface (CLI) is a straightforward way to experiment with the Entropy network and explore common workflows."
+aliases:
+    - "cli"
+---

content/reference/command-line-interface/install.md

@@ -0,0 +1,118 @@
+---
+title: "Install and Configure"
+lead: "This guide covers everything you need to get up and running with the Entropy CLI. We'll walk you through installation, configuration, and even log management."
+weight: 5
+---
+
+## Install
+
+Follow these steps to install Entropy globally using NPM:
+
+1. The CLI requires Node version 20 or higher to run:
+
+    ```shell
+    node --version
+    ```
+
+    ```output
+    v23.1.0
+    ```
+
+    {{< callout type="info" >}}
+    Consider using [Node Version Manager (NVM)](https://github.com/nvm-sh/nvm) to keep your Node installation organized. NVM also makes it trivial to switch between Node versions when necessary.
+    {{< /callout >}}
+
+1. Install the Entropy CLI globally using NPM:
+
+    ```shell
+    npm install --global @entropyxyz/cli
+    ```
+
+1. You can now run the CLI from anywhere using `entropy`:
+
+    ```shell
+    entropy
+    ```
+
+    ```output
+    Usage: entropy [options] [command]
+
+    CLI interface for interacting with entropy.xyz. Running without commands starts an interactive ui
+
+    Options:
+      -e, --endpoint <endpoint>                           Runs entropy with the given endpoint and ignores
+                                                          network endpoints in config. Can also be given a
+                                                          stored endpoint name from config eg: `entropy
+
+                                                          --endpoint test-net`. (default:
+                                                          "ws://testnet.entropy.xyz:9944/", env: ENDPOINT)
+      -h, --help                                          display help for command
+
+    Commands:
+      list|ls                                             List all accounts. Output is JSON of form [{ name,
+                                                          address, data }]
+
+      balance [options] <address>                         Get the balance of an Entropy account. Output is a
+
+                                                          number
+      transfer [options] <source> <destination> <amount>  Transfer funds between two Entropy accounts.
+      sign [options] <address> <message>                  Sign a message using the Entropy network. Output is
+                                                          a signature (string)
+    ```
+
+
+1. You can also interact with the CLI through the TUI by adding `tui`:
+
+    ```shell
+    entropy tui
+    ```
+
+    ```output
+    ? Select Action (Use arrow keys)
+
+    ❯ Manage Accounts
+      Balance
+      Register
+      Sign
+      Transfer
+      Deploy Program
+      User Programs
+      Exit
+    ```
+
+## Configuration
+
+The CLI uses a configuration file to set and store basic information. This CLI uses [env-paths](https://www.npmjs.com/package/env-paths) to determine where configurations files should be stored:
+
+- **Arch**: `~/.config/entropy-cryptography/entropy-cli.json`
+- **MacOS**: `/Library/Preferences/entropy-cryptography/entropy-cli.json`
+- **Ubuntu**: `~/.config/entropy-cryptography/entropy-cli.json`
+- **Windows**: `C:\Users\<USERNAME>\AppData\Roaming\entropy-cryptography\Config\entropy-cli.json`
+
+### Config file contents
+
+This configuration file contains:
+
+| Description | Name in configuration file |
+| ----------- | -------------------------- |
+| Account information | `accounts: [...]` |
+| Which account is currently selected | `selectAccount` |
+| Endpoints that you are connected to | `endpoints: {...}` |
+| Configuration version | `migration-version` |
+
+{{< callout type="danger" >}}
+The config file contains your unencrypted private key.
+{{< /callout >}}
+
+### Deleting your config
+
+The config file gets generated the first time that you start the CLI. If you somehow _break_ your config, you can delete your existing config and start the CLI -- it will generate a new base config.
+
+## Logs
+
+Similar to the configuration file, log files for this CLI can be found in the default [env-paths](https://www.npmjs.com/package/env-paths) locations:
+
+- **Arch**: `~/.local/state/entropy-cryptography/`
+- **MacOS**: `/Library/Logs/entropy-cryptography/`
+- **Ubuntu**: `~/.local/state/entropy-cryptography/`
+- **Windows**: `C:\Users\<USERNAME>\AppData\Local\entropy-cryptography\Log`