gnolang · moul · Nov 9, 2023 · Aug 9, 2023 · Aug 9, 2023 · Aug 10, 2023
diff --git a/docs/gno-docs/.gitignore b/docs/gno-docs/.gitignore
@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/docs/gno-docs/babel.config.js b/docs/gno-docs/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};
diff --git a/docs/gno-docs/docs/explanation/gno-doc.md b/docs/gno-docs/docs/explanation/gno-doc.md
@@ -0,0 +1,7 @@
+---
+id: gno-doc
+---
+
+# Gno Doc
+
+TODO 
diff --git a/docs/gno-docs/docs/explanation/gno-language.md b/docs/gno-docs/docs/explanation/gno-language.md
@@ -0,0 +1,7 @@
+---
+id: gno-language
+---
+
+# The Gno Language
+
+TODO
diff --git a/docs/gno-docs/docs/explanation/gno-modules.md b/docs/gno-docs/docs/explanation/gno-modules.md
@@ -0,0 +1,7 @@
+---
+id: gno-modules
+---
+
+# Gno Modules
+
+TODO 
diff --git a/docs/gno-docs/docs/explanation/gno-test.md b/docs/gno-docs/docs/explanation/gno-test.md
@@ -0,0 +1,7 @@
+---
+id: gno-test
+---
+
+# Gno Test
+
+TODO
diff --git a/docs/gno-docs/docs/explanation/gno-tooling.md b/docs/gno-docs/docs/explanation/gno-tooling.md
@@ -0,0 +1,7 @@
+---
+id: gno-tooling
+---
+
+# Gno Tooling
+
+TODO
diff --git a/docs/gno-docs/docs/explanation/gnovm.md b/docs/gno-docs/docs/explanation/gnovm.md
@@ -0,0 +1,7 @@
+---
+id: gnovm
+---
+
+# GnoVM
+
+TODO
diff --git a/docs/gno-docs/docs/explanation/ibc.md b/docs/gno-docs/docs/explanation/ibc.md
@@ -0,0 +1,7 @@
+---
+id: ibc
+---
+
+# IBC
+
+TODO
diff --git a/docs/gno-docs/docs/explanation/packages.md b/docs/gno-docs/docs/explanation/packages.md
@@ -0,0 +1,7 @@
+---
+id: packages
+---
+
+# Packages
+
+TODO
diff --git a/docs/gno-docs/docs/explanation/realms.md b/docs/gno-docs/docs/explanation/realms.md
@@ -0,0 +1,7 @@
+---
+id: realms
+---
+
+# Realms
+
+TODO
diff --git a/docs/gno-docs/docs/explanation/standard-library.md b/docs/gno-docs/docs/explanation/standard-library.md
@@ -0,0 +1,7 @@
+---
+id: explain-standard-library
+---
+
+# Gno Standard Library
+
+TODO 
diff --git a/docs/gno-docs/docs/explanation/tendermint2.md b/docs/gno-docs/docs/explanation/tendermint2.md
@@ -0,0 +1,7 @@
+---
+id: tendermint2
+---
+
+# Tendermint2
+
+TODO
diff --git a/docs/gno-docs/docs/getting-started/browsing-gno-source-code.md b/docs/gno-docs/docs/getting-started/browsing-gno-source-code.md
@@ -0,0 +1,96 @@
+---
+id: browsing-gno-source-code
+---
+
+# Browsing Gno Source Code
+
+## Overview
+
+In this tutorial, you will learn how to browse deployed Gno [Realms](../explanation/realms.md)
+and [Packages](../explanation/packages.md). Additionally, you will understand how the `Render` method is utilized
+to achieve Realm state visibility.
+
+## Prerequisites
+
+- **`gnoweb` set up. Reference the [Installation](installation.md#3-installing-other-gno-tools) guide for steps**
+
+## 1. Start the local chain
+
+In order for `gnoweb` to fetch realm and package source code, it needs to connect a running Gno node. For a better
+overview on running a local node, please reference the [Starting a Local Chain](setting-up-a-local-chain.md) guide.
+
+In this guide, we will start a local node with the default configuration. Navigate to the `gno.land` sub-folder and run:
+
+```bash
+gnoland start
+```
+
+## 2. Start `gnoweb`
+
+Now that the chain is running, we can start the `gnoweb` tool:
+
+```bash
+gnoweb
+```
+
+:::info Different JSON-RPC URL
+
+In case you are running a node on a different JSON-RPC URL from the default one (`http://127.0.0.1:26657`),
+you can specify the remote URL with the `gnoweb` flag named `--remote`
+
+:::
+
+We should be able to access the website locally on http://127.0.0.1:8888/.
+
+![gnoweb screen](../../static/img/getting-started/browsing-gno-source-code/gnoweb.png)
+
+## 3. Browse Package source code
+
+Packages in Gno.land usually have names resembling `gno.land/p/<name>`. Since packages do not contain state, we can only
+view their source code on-chain. To learn more about Packages, please check out
+the [Packages](../explanation/packages.md) explanation document.
+
+Using `gnoweb`, we can browse the source code in our browser.
+For example, the `avl` package is deployed at `gno.land/p/demo/avl`.
+
+To access the source code of the `avl` package, we can append the `/p/demo/avl` to our browser URL (from the homepage).
+
+The final URL for the `avl` package source could be viewable at http://127.0.0.1:8888/p/demo/avl, if we followed
+default setup params, as we did in this guide.
+
+![gnoweb avl](../../static/img/getting-started/browsing-gno-source-code/gnoweb-avl.png)
+
+From here, we can open any source code file of the deployed on-chain package and inspect its API.
+
+## 4. Browse Realm source code
+
+In contrast to Packages, Realms in Gno.land usually have names resembling `gno.land/r/<name>`.
+
+Realms _do_ contain state, and in addition to being able to view their source code on-chain, users can also view their
+internal state representation in the form of the `Render()` output. To learn more about Realms, please
+check out the [Realms](../explanation/realms.md) explanation document.
+
+Using `gnoweb`, we can browse the Realm `Render()` method output and source code in our browser.
+For example, the `boards` Realm is deployed at `gno.land/r/demo/boards`.
+
+To view the internal Realm state of the `boards` package, we can append the `/r/demo/boards` to our browser URL (from
+the homepage).
+
+The final URL for the `boards` Realm internal state could be viewable at http://127.0.0.1:8888/r/demo/boards, if we
+followed
+default setup params, as we did in this guide.
+
+![gnoweb boards](../../static/img/getting-started/browsing-gno-source-code/gnoweb-boards.png)
+
+:::info Render() is not required
+
+Internal Realm state does not have to be exposed through the `Render()` method of the realm, as it is
+not a requirement for deploying a Realm.
+
+:::
+
+Additionally, to view the source code for the realm, we simply need to append the `/` to the full realm path:
+
+http://127.0.0.1:8888/r/demo/boards/
+
+![gnoweb boards source](../../static/img/getting-started/browsing-gno-source-code/gnoweb-boards-source.png)
diff --git a/docs/gno-docs/docs/getting-started/installation.md b/docs/gno-docs/docs/getting-started/installation.md
@@ -0,0 +1,111 @@
+---
+id: installation
+---
+
+# Installation
+
+## Overview
+
+In this tutorial, you will learn how to set up the Gno development environment locally, so you
+can get up and running writing Gno code. You will download and install all the necessary tooling,
+and validate that they are correctly configured to run on your machine.
+
+## Prerequisites
+
+- **Git**
+- **`make` (for running Makefiles)**
+- **Go 19+**
+
+## 1. Cloning the repository
+
+To get started with a local Gno.land development environment, you must clone the GitHub repository
+somewhere on disk:
+
+```bash
+git clone https://github.com/gnolang/gno.git
+```
+
+## 2. Installing the `gno` development toolkit
+
+Next, we are going to build and install the `gno` development toolkit.
+`gno` provides ample functionality to the user, among which is running, precompiling, testing and building `.gno` files.
+
+To install the toolkit, navigate to the `gnovm` folder from the repository root, and run the `build` make directive:
+
+```bash
+cd gnovm
+make build
+```
+
+This will build out the necessary `gno` binary into the `gnovm/cmd` sub-folder:
+
+![gno tool build](../../static/img/getting-started/installation/make-build-gnovm.gif)
+
+Next, to make development easier, we need to make the binary available system-wide.
+From the same `gnovm` sub-folder, you can run:
+
+```bash
+make install
+```
+
+To verify the `gno` binary is installed system-wide, you can run:
+
+```bash
+gno --help
+```
+
+You should get the help output from the command:
+
+![gno help](../../static/img/getting-started/installation/gno-help.gif)
+
+Alternatively, if you don't want to have the binary callable system-wide, you can run the binary directly:
+
+```bash
+go run ./cmd/gno --help
+```
+
+## 3. Installing other `gno` tools
+
+The next step is to install several other tools that are required for the Gno development environment, like
+
+- `gnoland` - the Gno [blockchain node](setting-up-a-local-chain.md)
+- `gnokey` - the Gno [private key manager](creating-a-key-pair.md)
+- `gnoweb` - the Gno [source code viewer](browsing-gno-source-code.md)
+- `gnofaucet` - the Gno [native currency faucet](setting-up-funds/running-a-faucet.md)
+
+To build these tools, from the root directory navigate to the `gno.land` sub-folder, and run the `build` make
+directive:
+
+```bash
+cd gno.land
+make build
+```
+
+This will build out the necessary binaries into the `gno.land/cmd` sub-folder:
+
+![gno tools build](../../static/img/getting-started/installation/make-build-gnoland.gif)
+
+Same as with the `gno` tool, we can make these binaries available system-wide.
+From the same `gno.land` sub-folder, you can run:
+
+```bash
+make install
+```
+
+To verify that, for example, the `gnokey` binary is installed system-wide, you can run:
+
+```bash
+gnokey --help
+```
+
+You should get the help output from the command:
+
+![gnokey help](../../static/img/getting-started/installation/gnokey-help.gif)
+
+## Conclusion
+
+That's it 🎉
+
+You have successfully built out and installed the necessary tools for Gno development!
+
+In further documents, you will gain a better understanding on how they are used to make Gno work.