Docs update readme (#694)

* First version of Osmosis docs site. Work in progress. * Updated docs build branch trigger to the doc branch in order to test it. Once this is ready it will be changed back to the main branch. * Updated Doc Git Action's title * Joining Testnet Github Pages (#605) * Czar docs for PR to docs/dev * test * Added joining testnet instructions * Joining Mainnet Github Pages (#606) * Czar docs for PR to docs/dev * test * Added joining testnet instructions * Joining mainnet instructions completed with minor testnet changes * New sidebar structure Breakdown of joining testnet/mainnet Separated instructions for installing CLI Added new integration's section with the token listing process Created new terminology page Removed other-features, moved LBPs into the liquidity section Created a new wallet's section place holder. * Added home page, navbar, osmo theme color, and squared out logo (#607) (#608) * Czar docs for PR to docs/dev * test * Added joining testnet instructions * Joining mainnet instructions completed with minor testnet changes * added home page, navbar, osmo theme color, and squared out logo Co-authored-by: Daniel Farina <dan@osmosis.team> Co-authored-by: Adam Tucker <adamleetucker@outlook.com> Co-authored-by: Daniel Farina <dan@osmosis.team> * New theme New stylesheet overwrite New config Typescript based Added app screenshot on intro Moved a few sections around Added block explorer links Updated home page links * Intro page app screenshot * Docs dev (#613) * Updated Doc Git Action's title * Joining Testnet Github Pages (#605) * Czar docs for PR to docs/dev * test * Added joining testnet instructions * Joining Mainnet Github Pages (#606) * Czar docs for PR to docs/dev * test * Added joining testnet instructions * Joining mainnet instructions completed with minor testnet changes * New sidebar structure * Breakdown of joining testnet/mainnet * Separated instructions for installing CLI * Added new integration's section with the token listing process * Created new terminology page * Removed other-features, moved LBPs into the liquidity section * Created a new wallet's section place holder. * Added home page, navbar, osmo theme color, and squared out logo (#607) (#608) * Czar docs for PR to docs/dev * test * Added joining testnet instructions * Joining mainnet instructions completed with minor testnet changes * added home page, navbar, osmo theme color, and squared out logo Co-authored-by: Adam Tucker <adamleetucker@outlook.com> Co-authored-by: Daniel Farina <dan@osmosis.team> * Simplified navigation Added wallet doc (needs work, place holder) Added Osmosis App section Created the Develop/Validate/Integrate folders with unique navigation for each. * Example of Keplr instructions with screen captures. Other fixes. * Adding some screen capture examples to Kepler guide. * Example of visual instructions. * Osmosis labs docs (#617) * create section bookmarks, mainnet/testnet division, homepage simplify * accidental merge issue * Docs vue (#622) * Updated Docs based on VUEPRESS 1.x * Deleted old files * Adding discord & Github card Small padding fix * added validator instructions, fixed dark mode logo, dark mode card text to black * Updated integrator & validators doc & nav. Co-authored-by: Adam Tucker <adamleetucker@outlook.com> * package update * sidebar fixes * Add base to site in order for assets to load correctly. * Image path fix. * Docs vue (#624) * Updated Docs based on VUEPRESS 1.x * Deleted old files * Adding discord & Github card Small padding fix * added validator instructions, fixed dark mode logo, dark mode card text to black * Updated integrator & validators doc & nav. * v0.0.2 * added more validator instructions, got rid of inline css and changed class instead * included smooth scrolling, code clipboard button, included line numbers with line number spacing fix, reduced white in dark mode * validator sidebar bug fix, must have osmo in wallet paragraph, track validator active set command * small code cleanup before testing larger change * night switch changes color, changed palette to exact osmo colors, changed searchbar * Navbar breakpoint increased, mobile colors corrected, dark mode switch color corrected * logo padding fix, color adjust Co-authored-by: Adam Tucker <adamleetucker@outlook.com> * Fix small typo * Fix small typo * Merge remote-tracking branch 'origin/docs' into docs-vue * plugin-resgister-compenents 2.0.0 caused build issues on git pages, moved down to 1.3.1 * absolute image path fix * relative path img * img path fix attempt * img path fixed and button fill issue * version update to force cache update * fill issues * osmo bullets * mobile fixes * further mobile fixes * color correction * revive dead links * added testnet instructions using v4 and snapshot * Deleted sample modules doc's Created placeholder for Osmosis modules We will reference all native modules after we document our modules first. * Updated sidebar - Added new modules, deleted old place holders. * Added the official gamm module documentation. * title updates * title updates * Added txfees docs * Added lockup docs * testnet snapshot link improved * Added validator home page, removed manual as of dates * Simplified APP docs structure. * Integrate and Validate have home pages * homepage change cards * created home pages for all tabs but overview, added pictures for network resource cards * homepage redesign for simplicity * changed home page * code background change, icon improvement * code line height did not match numbering * v5 testnet instructions * update package.json version for cache reset * disable smooth scroll until snap to line is fixed * changed to v5 rc2 * added gov module, added verticle lines to tables * no more boring scroll bars * small gov change * changed code copy button and plugin * fixed new snapshot links, added tabs for each type of node * clarified node instructions, clarified gov module, small grammar errors * fixed checksum instructions * add git pull to commands, fixed clipboard text copied * mint module completed * added unsafe_skip_backup changes * added nested tables, making snapshot dl easy. Re enable smoothscroll since fixed * changed to v5 for cli init * stuck with wget * validator instructions were duplicated * removed prep cosmovisor instructions since upgrade happened * changed icons, darkened dark mode * V6 instructions * combined update of cosmovisor and osmosisd * added lockup module docs, added module landing page * changed 4.2.0 to 6.0.0 * added gamm module docs * module work, standardizing * gov module token burn rules * updated testnet mp20 snapshot command * added incentives module, changed $URL quicksync * chainlayer's checksum isnt always hosted correctly * Testing base path for domain config Changing base path to make docs.osmosis.zone work properly. * fixed paths for docs.osmosis.zone assets * meta tag test * open graph img * finishing modules, minor updates for soft launch * dark mode edits * Finished the OSMOSIS AMM overview Added keys for Argolia search, still need indexing. * backslashes break command * Created new section for web development documentation Updated navigation Updated links * Update repo's main README to point to the official documentation. - Removed note about implementation changes without documentation - Replaced Quickstart section with link to official docs - Replaced "Launch Osmosis" with links to "Joining the Mainnet" from the official docs I left everything else the same but we could clean it, make it leaner. Co-authored-by: Adam Tucker <adamleetucker@outlook.com> Co-authored-by: Daniel Farina <dan@osmosis.team>
osmosis-labs · Dec 28, 2021 · 92ed4d9 · 92ed4d9
1 parent 8dcbaf5
commit 92ed4d9
Show file tree

Hide file tree

Showing 8 changed files with 100 additions and 50 deletions.
diff --git a/README.md b/README.md
@@ -1,46 +1,18 @@
 # Osmosis
-_(Note: This repository is under active development. Architecture and implementation may change without documentation)_
+_(Note: This repository is under active development)_
 
 Osmosis is a fair-launched, customizable automated market maker for interchain assets that allows the creation and management of non-custodial, self-balancing, interchain token index similar to one of Balancer.
 
 Inspired by [Balancer](http://balancer.finance/whitepaper) and Sunny Aggarwal's '[DAOfying Uniswap Automated Market Maker Pools](https://www.sunnya97.com/blog/daoifying-uniswap-automated-market-maker-pools)', the goal for Osmosis is to provide the best-in-class tools that extend the use of AMMs within the Cosmos ecosystem beyond traditional token swap-type use cases. Bonding curves, while have found its primary use case in decentralized exchange mechanisms, its potential use case can be further extended through the customizability that Osmosis offers. Through the customizability offered by Osmosis such custom-curve AMMs, dynamic adjustments of swap fees, multi-token liquidity pools–the AMM can offer decentralized formation of token fundraisers, interchain staking, options market, and more for the Cosmos ecosystem.
 
-Whereas most Cosmos zones have focused their incentive scheme on the delegators, Osmosis attempts to align the interests of multiple stakeholders of the ecosystem such as LPs, DAO members, as well as delegators. One mechanism that is introduced is how staked liquidity providers have sovereign ownership over their pools, and through the pool governance process allow them to adjust the parameters depending on the pool’s competition and market conditions. Osmosis is a sovereign Cosmos zone that derives its sovereignty not only from its application-specific blockchain architecture but also the collective sovereignty of the LPs that has aligned interest to different tokens that they are providing liquidity for.
+Whereas most Cosmos zones have focused the  ir incentive scheme on the delegators, Osmosis attempts to align the interests of multiple stakeholders of the ecosystem such as LPs, DAO members, as well as delegators. One mechanism that is introduced is how staked liquidity providers have sovereign ownership over their pools, and through the pool governance process allow them to adjust the parameters depending on the pool’s competition and market conditions. Osmosis is a sovereign Cosmos zone that derives its sovereignty not only from its application-specific blockchain architecture but also the collective sovereignty of the LPs that has aligned interest to different tokens that they are providing liquidity for.
 
-## Quickstart
+## Documentation
+For the most up to date documentation please visit [docs.osmosis.zone](https://docs.osmosis.zone/)
 
-This is what you'd use to get a node up and running, fast. It assumes that it is starting on a blank ubuntu machine.  It eschews a systemd unit, allowing automation to be up to the user.  It assumes that installing Go is in-scope since Ubuntu's repositories aren't up to date and you'll be needing go to use osmosis.  It handles the Go environment variables because those are a common pain point.
+## Joining the Mainnet
 
-**Install go**
-```bash
-wget -q -O - https://git.io/vQhTU | bash -s -- --version 1.17.2
-```
-
-Then exit and re-enter your shell.
-
-**Install Osmosis and check that it is on $PATH**
-```bash
-git clone https://github.com/osmosis-labs/osmosis
-cd osmosis
-git checkout v3.1.0
-make install
-which osmosisd
-```
-
-**Launch Osmosis**
-```bash
-osmosisd init yourmonikerhere
-wget -O ~/.osmosisd/config/genesis.json https://github.com/osmosis-labs/networks/raw/main/osmosis-1/genesis.json
-osmosisd start
-```
-
-More Nodes ==> More Network
-
-More Network ==> Faster Sync
-
-Faster Sync ==> Less Developer Friction
-
-Less Developer Friction ==> More Osmosis
+[Please visit the official instructions on how to join the Mainnet here.](https://docs.osmosis.zone/developing/network/join-mainnet.html#install-osmosis-binary)
 
 Thank you for supporting a healthy blockchain network and community by running an Osmosis node!
 

diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -177,9 +177,9 @@ module.exports = {
           collapsable: false,
         },
         {
-          title: 'Developer Guide',
+          title: 'Chain Developer Guide',
           children: [
-            '/developing/dev-guide',
+            '/developing/chain-dev-guide',
             '/developing/cli/',
             '/developing/cli/install',
           ],
@@ -216,6 +216,13 @@ module.exports = {
           ],
           collapsable: true,
         },
+        {
+          title: 'Web Developer Guide',
+          children: [
+            '/developing/web-dev-guide'
+          ],
+          collapsable: true,
+        },
       ],
       '/validators': [
         {

diff --git a/docs/developing/README.md b/docs/developing/README.md
@@ -2,15 +2,15 @@
 title: Developer Home
 ---
 
-# Develop
+# Chain Development
 
 The guides on this page will explain the process of developing on Osmosis.
 
 <div class="cards twoColumn">
-  <a href="dev-guide.html" class="card">
+  <a href="chain-dev-guide.html" class="card">
     <img src="/img/book-solid.svg" class="filter-icon"/>
     <div class="title">
-     Developer Guide
+     Chain Developer Guide
     </div>
     <div class="text">
       Basic developer overview, CLI guide, and install osmosis
@@ -54,4 +54,22 @@ The guides on this page will explain the process of developing on Osmosis.
       Osmosis modules and their respective CLI commands
     </div>
   </a>
- </div>
+ </div>
+
+
+# Web Development
+
+The guides on this page will explain the process of developing on the Osmosis front-end interface.
+
+<div class="cards twoColumn">
+  <a href="web-dev-guide.html" class="card">
+    <img src="/img/book-solid.svg" class="filter-icon"/>
+    <div class="title">
+    Web Developer Guide
+    </div>
+    <div class="text">
+      Running Osmosis front-end on a development environment
+    </div>
+  </a>
+
+ </div>
diff --git a/docs/developing/dev-guide.md → docs/developing/chain-dev-guide.md b/docs/developing/dev-guide.md → docs/developing/chain-dev-guide.md
diff --git a/docs/developing/modules/README.md b/docs/developing/modules/README.md
@@ -1,5 +1,5 @@
 ---
-title: Module Home
+title: Modules
 ---
 
 # Modules
@@ -91,4 +91,4 @@ While module functions can be called in many different orders, here is a basic f
 3. (GAMM) Join Pool
 4. (lockup) Lock-tokens
 5. (lockup) Begin-unlock-tokens
-6. (GAMM) Exit Pool
+6. (GAMM) Exit Pool
diff --git a/docs/developing/web-dev-guide.md b/docs/developing/web-dev-guide.md
@@ -0,0 +1,53 @@
+# Osmosis Web Interface
+Frontend React app for Osmosis AMM.
+
+![](../assets/welcome.png)
+
+## Install global dependencies
+To run or build the app, first, need to install `Node.js` and `Yarn` globally;
+
+First Install Node (recommend 14.x.x LTS version) from;
+
+https://nodejs.org/
+
+Then install Yarn;
+```bash
+npm install -g yarn
+# OR
+sudo npm install -g yarn
+```
+
+## Install project dependencies
+First clone the repo;
+```bash
+git clone https://github.com/osmosis-labs/osmosis-frontend.git && cd osmosis-frontend
+```
+
+Then install project dependencies;
+```bash
+yarn
+```
+
+## Build
+To build the static assets;
+```bash
+yarn build
+```
+This should produce `prod` folder with static assets.
+
+Currently, Osmosis frontend app is SPA with entry point: `prod/index.html`
+
+## Development
+To spin up the local dev server;
+```bash
+yarn dev
+```
+The app should be live at http://localhost:8081
+
+
+## License
+
+This work is dual-licensed under Apache 2.0 and MIT.
+You can choose between one of them if you use this work.
+
+`SPDX-License-Identifier: Apache-2.0 OR MIT`
diff --git a/docs/validators/validating-mainnet.md b/docs/validators/validating-mainnet.md
@@ -85,16 +85,16 @@ If you need further explanation for each of these command flags:
 To see the current validator active set:
 
 ```bash
-osmosisd query staking validators -o json | jq -r '.validators[] | \
-[.operator_address, .status, (.tokens|tonumber / pow(10; 6)), \
+osmosisd query staking validators -o json | jq -r '.validators[] | 
+[.operator_address, .status, (.tokens|tonumber / pow(10; 6)), 
 .commission.update_time[0:19], .description.moniker] | @csv' | column -t -s","
 ```
 
 You can search for your specific moniker by adding grep MONIKER at the end:
 
 ```bash
-osmosisd query staking validators -o json | jq -r '.validators[] | \
-[.operator_address, .status, (.tokens|tonumber / pow(10; 6)), \
+osmosisd query staking validators -o json | jq -r '.validators[] | 
+[.operator_address, .status, (.tokens|tonumber / pow(10; 6)), 
 .commission.update_time[0:19], .description.moniker] | @csv' | column -t -s"," | grep Wosmongton
 ```
 

diff --git a/docs/validators/validating-testnet.md b/docs/validators/validating-testnet.md
@@ -85,16 +85,16 @@ If you need further explanation for each of these command flags:
 To see the current validator active set:
 
 ```bash
-osmosisd query staking validators -o json | jq -r '.validators[] | \
-[.operator_address, .status, (.tokens|tonumber / pow(10; 6)), \
+osmosisd query staking validators -o json | jq -r '.validators[] | 
+[.operator_address, .status, (.tokens|tonumber / pow(10; 6)), 
 .commission.update_time[0:19], .description.moniker] | @csv' | column -t -s","
 ```
 
 You can search for your specific moniker by adding grep MONIKER at the end:
 
 ```bash
-osmosisd query staking validators -o json | jq -r '.validators[] | \
-[.operator_address, .status, (.tokens|tonumber / pow(10; 6)), \
+osmosisd query staking validators -o json | jq -r '.validators[] | 
+[.operator_address, .status, (.tokens|tonumber / pow(10; 6)), 
 .commission.update_time[0:19], .description.moniker] | @csv' | column -t -s"," | grep Wosmongton
 ```