Major docs site revamp (#45)

* Slugifies md file names. Adds sidebar positions. (#30)

* Moves every .md file. Breaks links.

* Completes new directory structure.

* Hard-codes sidebar for ordering

* Disable auto-collapsing sidebar.

* Adds support process and ISSUE_TEMPLATE to this repo. (#42)

* Adds basic support process.

* Adds ISSUE_TEMPLATE.

* Uses Arial, Helvetica, or local sans-serif fonts first. (#44)

* Improves repo hygiene. (#46)

* Removes LOTS of old config files.

* Adds AGPL-3.0 license.

* Adds a bunch of useful stuff to the README.

* Adds local server and build instructions.

* Fixes broken links from content re-arch.

* Deletes footer stuff for now.

* Bolds toplevel items in sidebar.

* Adds super basic plan for Quickstart.

* Ignores Yarn stuff because it's not fun.

* Adds basic pages for new guides.

* Moves CLI page from another branch.

* Updates sidebar to use newly added pages.

* Add install instructions to CLI.

* Updates yarn.lock, for some reason.

* Disable hover for top-level sidebar items.

* Hides everything in Guides.

I'm hiding these pages (and elements in the sidebar) until there's
actually content in them.

* Improves README header with links to project, issues, and LICENSE.

* Adds some quickstart content.

* Adds steps up the Register in quickstart.

* Hides SDK page for now.

* Adds beta warning. Moves functions into sections.

* Hides sections of CLI that aren't complete.

* Updates Node Encryption and Auhentication from PR.

* Fix links to API docs now that crate documentation is available on docs.rs (#58)

* Removes problematic link to SDK docs.

* Cleans up front-end a little bit.

* Removes image placeholder for now.

* Moves missing-faucet callout.

* Updates license name in README.

* Uses yarn start instead of the NPM global install process.

* Grammar and spell check.

* Uses new menu.

* Adds 'Get test funds' to guides section. (#63)

* Creates a "Manage accounts" guide. (#60)

* Fixes borked numbering in quickstart under Get Test Funds.

* Makes the site look less like a Docusaurus site.

* Adds Create an Address guide to sidebar.

* Renames guide to "Manage accounts".

* Adds 'Testnet Details' page. (#64)

* Adds boilerplate for Testnet Details page.

* Changes testnet page to Networks page, with subsections.

* Adds basic testnet details.

* Grammar and spell check.

* Adds JS specific glossary items. (#66)

* Adds JS-specific glossary items into glossary.

* Adds link to TSS page from glossary.

* Removes duplicate entries from glossary.

* Adds callout to go to Entrosplainer first.

* Re-adds missing images.

* Grammar and spelling fixes for Concepts.

* Refactors `/concepts` section for readbility. (#73)

* Re-adds missing images.

* Grammar and spelling fixes for Concepts.

* Update sidebar with proper filenames.

* Renames Register to Registering.

* Renames Program Features to Programs.

* Renames files in Concepts. Removes unnecessary template file. (#74)

* Update sidebar with proper filenames.

* Renames Register to Registering.

* Renames Program Features to Programs.

* Removes example.md file. Don't need it.

* Fixes broken frontmatter.

* Add a guide for using Polkadot chain explorer with Entropy. (#75)

* Fixes broken front-matter.

* Adds placeholder for Polkadot Explorer page.

* Add 'Use the explorer' guide.

* Grammar and spelling check.

* Fixes broken image link.

This link was stopping the build from running. Fixes it now though.

* Fixes broken internal links.

* Adds deps lock file.

* Add visual reminder of outbound links. (#77)

* Adds Transfer Funds guide. (#81)

* Adds bolierplate content for Transfer Funds guide.

* Adds images to transfer guide.

* Grammar and spelling check.

* Updates site logos. (#92)

* Adds missing images. Sets Entropy logo top left.

* Removes old images. Not needed.

* Adds dark mode logo.

* Adds one-liner install and Troubleshooting section

* Update's quickstart to match `main` branch in CLI (#94)

* Makes codeblock rectangles sharp. Hides command output copy button.

* Hides copybutton from output codeblocks.

* Hides copy button from command outputs.

* Hides copy button on CMD outputs.

* Sets different background for command outputs.

* Adds image for getting funds from GitHub repo faucet.

* Completes quickstart with all the steps.

* Adds CLI crash troubleshooting.

* Updates codeblock syntax.

* Adds basic information for all CLI functions. (#95)

* Adds Subkey process for generating accounts. (#96)

---------

Co-authored-by: peg <peg@magmacollective.org>

.github/ISSUE_TEMPLATE

@@ -0,0 +1,30 @@
+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.
+
+**Title**: `<A clear and concise title that reflects the nature of your issue.>`
+
+**Issue type**: (Select one)
+
+- [ ] Bug
+- [ ] Question
+- [ ] Improvement
+
+**Description**:
+
+Describe the issue you're encountering in detail.
+
+**Steps to reproduce**:
+
+Provide a step-by-step explanation of how to reproduce the issue.
+
+**Error messages**:
+
+Include any relevant error messages, logs, or screenshots.
+
+**Expected behavior**: 
+
+What were you expecting to happen? This seems like a silly question, but please be specific.
+
+**Additional information**:
+
+- Operating System: (e.g., Windows 10, macOS Monterey)
+- Other Software/Hardware: (if applicable)

.gitignore

@@ -15,8 +15,10 @@
 .env.test.local
 .env.production.local
 
+# Because JS has too many package managers...
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
-.yarn
+.yarn*
 .vercel
+.pnpm-lock.yaml

README.md

@@ -1,41 +1,160 @@
-# Entropy Docs - README
+<h1 align="center">Entropy Docs</h1>
+<p align="center">
+    <strong>This repository contains the documentation for the Entropy project (found in <code>/docs</code>) and all the build scripts to create the <a href="https://docs.entropy.xyz">docs.entropy.xyz</a> site. This repo also serves as the support hub for Entropy.</strong>
+    <br><br>
+    <a href="https://github.com/orgs/entropyxyz/projects/32">Project Board</a>
+    <a href="https://github.com/entropyxyz/entropy-docs/issues">Issues</a>
+    <a href="https://github.com/entropyxyz/entropy-docs/blob/main/LICENSE">MIT License</a>
+</p>
 
-This repository contains code that builds a Web site is using [Docusaurus 2](https://docusaurus.io/), a modern [static site generator](https://en.wikipedia.org/wiki/Static_site_generator).
+## Table of contents
 
-## Installation
+- [Run locally](#run-locally)
+- [Information architecture](#information-architecture)
+- [Repository structure](#repository-structure)
+- [Support](#support)
+- [Contributions](#contributions)
+- [License](#license)
 
-As Docusaurus is built with [Node.js](https://nodejs.org/), to build this site you will need:
+## Run locally
 
-* [the `yarn` package manager](https://yarnpkg.com/).
+This repository uses the Docusaurus static-site-generator to build docs.entropy.xyz. To run the site locally:
 
-Once installed, simply run `yarn` in the directory you cloned this codebase into. For example:
+1. Clone this repository and move into the new directory:
 
-```sh
-git clone https://github.com/entropyxyz/entropy-docs.git
-cd entropy-docs # Go to the repository root.
-yarn            # Performs installation.
-```
+    ```shell
+    git clone https://github.com/entropyxyz/entropy-docs
+    cd entropy-docs
+    ```
 
-## Local development
+1. Install the dependencies for Docusaurus (pick one package manage process, do not run all three):
 
-```sh
-yarn start
-```
+    ```shell
+    # Using NPM
+    npm install
+    ```
 
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+    ```shell
+    # Using PNPM
+    pnpm install
+    ```
 
-## Build
+    ```shell
+    # Using Yarn
+    yarn
+    ```
 
-```sh
-yarn build
-```
+1. Run the build scripts and run a local server:
+
+    ```shell
+    # Using NPM
+    npm run start
+    ```
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+    ```shell
+    # Using PNPM
+    pnpm run start
+    ```
 
-## Deployment
+    ```shell
+    # Using Yarn
+    yarn start
+    ```
 
-This site is hosted on [GitHub Pages](https://pages.github.com/). It uses the `gh-pages` Node.js package to make deploying to the GitHub Pages site easy (by automating the process of committing to the `gh-pages` branch in this repository).
+1. Go to [localhost:3000](http://localhost:3000) in your browser.
+1. To stop the local server, press `CTRL` + `c` in the terminal window.
 
-```sh
-npm run deploy # Deploy the site to GH Pages as your user.
+To _build_ the site but not serve it, run steps `1` and `2`, followed by `yarn build`. This will build the site and save it in `./build`.
+
+## Information architecture
+
+Documentation within this repository is found within the `/docs` directory. That directory is split into the following subdirectories:
+
+```plaintext
+docs
+|-- basics
+|-- concepts
+|-- guides
+`-- reference
 ```
+
+**Basics**: information that everybody needs to know in order to understand, and effectivly use, Entropy.
+**Concepts**: discusses ideas and concepts that everyone may not be familiar with, or things that are relevant only to Entropy and not other blockchains.
+**Guides**: easy-to-understand guides that show users how to hit a specific goal, without diving into the content discussed in `/concepts`.
+**Reference**: in-depth reference documentation for the CLI and SDK.
+
+## Repository structure
+
+| File or directory | Description |
+| --- | --- |
+| .docusaurus | Configuration directory specific to Docusaurus. Holds themes and plugins for this site. |
+| .git/ | Stores Git version control information (ignore). |
+| .github/ | Directory for GitHub specific configurations (ignore). |
+| .gitignore | File specifying files to be ignored by Git (ignore). |
+| LICENSE | File containing the license under which this project is distributed. |
+| README.md | This file. |
+| blog/ | Directory containing markdown files for Entropy Docs blog posts. This is currently un-used. |
+| docs/ | Core directory containing markdown files for Entropy technical documentation. |
+| docusaurus.config.js | Main configuration file for this Docusaurus project. |
+| package-lock.json | (Generated file) Lists exact versions of dependencies used in this project. |
+| package.json | File specifying project dependencies and scripts. |
+| sidebars.js | File defining the navigation structure for the docs site. Docusaurus depends on this file. |
+| src/ | Source code directory for this Docusaurus project, specifically React components. |
+| static/ | Directory for static assets used by docs.entropy.xyz site (images, fonts, etc.). |
+| tsconfig.json | Configuration file for TypeScript (ignore). |
+| yarn.lock | Similar to `package-lock.json`. Lists exact versions of dependencies used in this project. |
+
+## Support
+
+All support tickets are handled in the **Issues** tab of this repository. If you encounter anyone claiming to be from Entropy in any other location on the web (Discord, Discuss, Reddit, Twitter, etc) this is likely a scam.
+
+### Submitting a ticket
+
+To submit a suppor ticket:
+
+1. Click on the **Issues** tab within this repository.
+1. Select **New Issue**.
+1. Fill out the fields and click **Create issue**.
+1. Someone from Entropy will reach out to you within that issue thread for more details.
+
+### Discord
+
+We do not use Discord for support tickets. If you receive a message about a support ticket from someone claiming to be from Entropy, this is likely a scam. All support tickets are handled publically through GitHub Issues in this repository.
+
+## Contribute
+
+### Getting started
+
+**Fork the repository**: Before making changes, you'll need to create a fork of our repository on GitHub. This creates a copy in your own account that you can modify.
+
+**Clone your fork**: Once you've forked the repository, clone it to your local machine. This will allow you to make changes locally.
+
+### Making changes
+
+**Identify your contribution**: Look through the documentation in the `docs/` directory and find areas where you can improve the content, fix typos, or add new information.
+**Edit files**: Make the changes you'd like to see. Check out the [Docusaurus documentation](https://docusaurus.io/docs/markdown-features) for any specific markdown rules you might not be aware of.
+
+### Submitting your changes
+
+**Commit your changes**: Commit your changes with a descriptive message explaining what you modified.
+**Push your changes**: Push your committed changes to your forked repository on GitHub.
+**Create a pull request**: On GitHub, navigate to your forked repository and create a pull request. This sends a notification to the Entropy Docs team about your proposed changes.
+
+### Review Process
+
+**Review from the docs team**: The Entropy docs team will review your pull request and may ask questions or suggest edits.
+**Respond to feedback**: Be prepared to discuss your changes and make adjustments based on the feedback provided.
+**Merging your pull request**: Once your pull request is approved, we will merge your changes into the `main` branch.
+
+### Additional Tips
+
+**Small, focused changes**: Break down larger contributions into smaller, more manageable pull requests. This makes the review process easier and faster.
+**Test your changes**: Test your changes to ensure they don't introduce any unintended consequences.
+**Stay up-to-date**: Keep an eye on this repository for any updates or changes to the contribution guidelines.
+
+We appreciate your help in making our documentation even better. By following these guidelines, you can ensure a smooth and successful contribution process.
+
+## License
+
+- Most things in `/docs` are licensed under [MIT](./LICENSE) unless otherwise specified.
+- Docusaurus is _currently_ [MIT](https://github.com/facebook/docusaurus/blob/main/LICENSE) licensed. The maintainers of _this_ repository have no control on what license Facebook, and thus the Docusaurus team, apply to their code.