Update/documentation (#1300)

* removed unused technical setup * updated repo link * updated dev tool setup * removed starport * removed starport setup * refactored page numbers Co-authored-by: afti-githobo <[email protected]>
Pylons-tech · Nov 20, 2022 · f70432c · f70432c
1 parent 8ebcfb3
commit f70432c
Show file tree

Hide file tree

Showing 7 changed files with 607 additions and 67 deletions.
diff --git a/TECHNICAL-SETUP.md b/TECHNICAL-SETUP.md
@@ -12,14 +12,6 @@ This installation method removes existing Go installations, installs Go in `/usr
 
 **Note:** We recommend not using brew to install Go.
 
-## Install Starport
-
-To install the latest version of the `starport` binary use the following command.
-
-```shell
-curl https://get.starport.network/starport! | bash
-```
-
 ## Install Git pre-commit Hook
 
 Git `pre-commit` hooks run before any commit to the Git repository. These hooks verify that each commit passes basic formatting and linting checks.

diff --git a/docs/TESTNET.md b/docs/TESTNET.md
@@ -1,3 +1,3 @@
 # Pylons Testnets
 
-Information on how to get started with the pylons-testnet can be found in this [repo](https://github.com/Pylons-tech/pylons-testnet).
+Information on how to get started with the pylons-testnet can be found in this [repo](https://github.com/Pylons-tech/pylons).
diff --git a/docs/pylons-docs/content/dev-tool/page-1.md b/docs/pylons-docs/content/dev-tool/page-1.md
@@ -28,12 +28,6 @@ Run this command in the same directory as your Pylons directory:
 git clone https://github.com/Pylons-tech/dev-tool.git
 ```
 
-Within the Pylons directory run:
-
-```
-starport chain serve
-```
-
 If you haven't created an account on the test-net before, open a new terminal window and go to the pylons directory. Use the pylonsd commands to create a new account on the test-net. [See here for instructions.](https://github.com/Pylons-tech/pylons/blob/main/docs/Developer-CLI-Tutorial.md)
 
 Within the codebase of the dev-tool, open the developer folder and edit the `config.json` file. Add the account name that cookbooks/recipes will be created by and the home directory of the Pylons folder.

diff --git a/docs/pylons-docs/content/pylonsd/page-1.md b/docs/pylons-docs/content/pylonsd/page-1.md
@@ -1,72 +1,67 @@
 ---
-title: "Quick Start"
-date: 2022-04-26T12:27:33-05:00
+title: "Tech Setup"
+date: 2022-04-26T12:27:08-05:00
 draft: false
-weight: 1
+weight: 2
 ---
 
-## Get started
+# Technical Setup 
 
-```
-starport chain serve
-```
-
-`serve` command installs dependencies, builds, initializes, and starts your blockchain in development.
+To ensure you have a successful experience working with Pylons, your local system must meet these technical requirements.
 
-### Configure
+## Install Go
 
-The blockchain in development can be configured with `config.yml`. To learn more, see the [Starport docs](https://docs.starport.network).
+This installation method removes existing Go installations, installs Go in `/usr/local/go/bin/go`, and sets the environment variables.
 
-### Launch
+1. Go to <https://golang.org/dl>.
+1. Download the binary release that is suitable for your system.
+1. Follow the installation instructions.
 
-To launch the blockchain live on multiple nodes, use `starport network` commands. Learn more about [Starport Network](https://github.com/tendermint/spn).
+**Note:** We recommend not using brew to install Go.
 
-### Web Frontend
+## Install Git pre-commit Hook
 
-Starport has scaffolded a Vue.js-based web app in the `vue` directory. Run the following commands to install dependencies and start the app:
+Git `pre-commit` hooks run before any commit to the Git repository. These hooks verify that each commit passes basic formatting and linting checks.
 
-```
-cd vue
-npm install
-npm run serve
-```
+- Homebrew 
 
-or 
+    ```shell
+    brew install pre-commit
+    ```
 
-```
-cd vue
-yarn install
-yarn serve
-```
+- Pip package manager
 
-The frontend app is built using the `@starport/vue` and `@starport/vuex` packages. For details, see the [monorepo for Starport front-end development](https://github.com/tendermint/vue).
+    ```shell
+    pip install pre-commit
+    ```
 
-## Release
+## Install pre-commit in Your Local Pylons Repo
 
-To release a new version of your blockchain, create and push a new tag with `v` prefix. A new draft release with the configured targets will be created.
+After installing the `pre-commit` binary, run the following command in the base directory of the `pylons` repository:
 
-```
-git tag v0.1
-git push origin v0.1
+```shell
+pre-commit install
 ```
 
-After a draft release is created, make your final changes from the release page and publish it.
+Now, any time `git commit *` is run, the `pre-commit` hooks run before the commit can be finalized.
 
-### Install
+## Install Go Linters Aggregator
 
-To install the latest version of the blockchain node's binary, execute the following command on your machine:
+The `golangci-lint` linter runner is used in the `make lint` command that is provided to developers.
 
+To install `golangci-lint` into `$GOPATH/bin`, run:
+
+```shell
+curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.41.1
 ```
-curl https://get.starport.network/Pylons-tech/pylons@latest! | sudo bash
-```
 
-`Pylons-tech/pylons` should match the `username` and `repo_name` of the Github repository to which the source code was pushed. Learn more about [the install process](https://github.com/allinbits/starport-installer).
+## Install goimports tool
+
+The `goimports` tool is used int the `make format` command taht is provided to developers.
 
-## Learn more
+To install `goimports` using the `go get` command:
 
-- [Starport](https://github.com/tendermint/starport)
-- [Starport Docs](https://docs.starport.network)
-- [Cosmos SDK documentation](https://docs.cosmos.network)
-- [Cosmos SDK Tutorials](https://tutorials.cosmos.network)
-- [Discord](https://discord.gg/W8trcGV)
+```shell
+go get golang.org/x/tools/cmd/goimports
+```