|
1 | | -# Welcome to Lava Docs 📕 |
2 | | -This repository contains documentation for Lava. |
3 | | -The source is generated to [Lava Docs website](https://docs.lavanet.xyz/), but can also be browsed as plain source in the [Docs folder](/docs/). |
| 1 | + |
| 2 | + |
| 3 | +# Lava Documentation 📕 |
| 4 | + |
| 5 | +[](https://docs.lavanet.xyz)   [](https://discord.gg/EKzbc6bx) |
| 6 | + |
| 7 | + |
| 8 | +## Overview 🔎 |
| 9 | + |
| 10 | +This repository (**@lavanet/docs**) contains technical documentation for the Lava ecosystem. The most recent version of this repository is deployed to the Lava docs [website](https://docs.lavanet.xyz/) and is viewable there. If you're averse to rich formatting, Lava Documentation can also be browsed as plain source in the markdown files available in the [docs folder](/docs/) of this repository. The Lava docs website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator, and deployed using the [Netlify Web Platform](https://www.netlify.com/). |
| 11 | + |
| 12 | +Contents include: |
| 13 | + |
| 14 | +- Information on Lava's supported chains |
| 15 | +- Installation & Setup Guides for Validators, Providers, and Developers |
| 16 | +- Network & Protocol Details on Lava's Unique Features |
| 17 | +- Links to in-demand RPC & Web3 APIs |
| 18 | + |
| 19 | +## Contribution 👥 |
| 20 | + |
| 21 | +Contributing to the documentation of Lava is a rewarding way to give back to the ecosystem. We always welcome contributors with love & kindness. After reviewing this README, please read the [contribution](CONTRIBUTING.md) guide to help you get started. |
| 22 | + |
| 23 | + |
| 24 | +## Deployment 🚀 |
| 25 | + |
| 26 | +### Status |
4 | 27 |
|
5 | | -## Deployment |
6 | 28 | [](https://app.netlify.com/sites/sage-swan-13ac7b/deploys) |
7 | 29 |
|
8 | | -`main` branch is automatically deployed to docs site, and other branches and pull requests leverage Netlify deploy. |
| 30 | +### Process |
| 31 | +The `main` branch of this repository is automatically deployed to our docs site, and other branches and pull requests leverage Netlify deploy. Please note that unless you are a recognized contributor of this repository, each attempted PR generates a Netlify approval that will prevent your pull request from being merged. Once the request is approved and a Netlify deploy preview is generated, a Netlify deploy preview will appear in the body of your PR as `😎 Deploy Preview`. This deploy preview will be audited by a docs maintainer before merging your pull request. |
| 32 | + |
| 33 | +## Local Development 🔧 |
| 34 | + |
| 35 | +### 1. Fork this repository! |
| 36 | + |
| 37 | +We recommend naming your fork `lava-docs` to distinguish from other projects which might have similar naming conventions. |
9 | 38 |
|
10 | | -## Community & Contribution 😻 |
11 | | -We welcome contributors with love, please read the [contribution](CONTRIBUTING.md) guide to help you get started. |
| 39 | +### 2. Clone your fork |
12 | 40 |
|
13 | | -This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. |
| 41 | +SSH **(recommended)** |
14 | 42 |
|
15 | | -## Installation |
| 43 | +```bash |
| 44 | +git clone git@github.com:Your-User-Name-Here/lava-docs.git |
16 | 45 | ``` |
17 | | -$ yarn install |
| 46 | + |
| 47 | +HTTPS |
| 48 | + |
| 49 | +```bash |
| 50 | +git clone https://github.com/Your-User-Name-Here/lava-docs.git |
18 | 51 | ``` |
19 | | -Local Development |
| 52 | + |
| 53 | +### 3. Set up environmental variables |
| 54 | + |
| 55 | +```bash |
| 56 | +cd lava-docs/ |
| 57 | +cp .env.example .env |
20 | 58 | ``` |
21 | | -$ yarn start |
| 59 | + |
| 60 | +Change the contents of your environmental variables(`.env`) file to the following: |
| 61 | + |
22 | 62 | ``` |
23 | | -Build |
| 63 | +ALGOLIA_APP_ID=demo |
| 64 | +ALGOLIA_API_KEY=demo |
| 65 | +ALGOLIA_INDEX_NAME=demo |
24 | 66 | ``` |
25 | | -$ yarn build |
| 67 | + |
| 68 | +Algolia search needs values assigned to these in order to start. For local docs instances (w/ non-functional search), any dummy values will work. |
| 69 | + |
| 70 | +### 4. Install all packages |
| 71 | + |
26 | 72 | ``` |
27 | | -Deployment: |
28 | | -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. |
| 73 | +yarn install |
| 74 | +``` |
| 75 | + |
| 76 | +### 5. Host a local preview of the docs (*Optional*) |
29 | 77 |
|
30 | 78 | ``` |
31 | | -$ GIT_USER=<Your GitHub username> yarn deploy |
| 79 | +yarn start |
32 | 80 | ``` |
33 | 81 |
|
| 82 | +Your preview will dynamically change/hotload as you make changes to files. |
| 83 | + |
| 84 | +### 6. Build a local deployment of the docs (*Optional*) |
| 85 | + |
| 86 | +``` |
| 87 | +yarn build |
| 88 | +``` |
| 89 | + |
| 90 | +Your build will appear in the `./build/` folder of your docs directory. |
| 91 | + |
| 92 | +### 7. Deploy to Github (*Optional*) |
| 93 | + |
| 94 | +If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. |
| 95 | + |
| 96 | +``` |
| 97 | +$ GIT_USER=<Your GitHub username> yarn deploy |
| 98 | +``` |
0 commit comments