Skip to content

Commit 8ad6950

Browse files
committed
adjust README formatting
1 parent 5695cfb commit 8ad6950

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

+12-10
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Lava Documentation 📕
44

5-
[![Website](https://img.shields.io/badge/WEBSITE-https%3A%2F%2Fdocs.lavanet.xyz-green?style=for-the-badge)](https://docs.lavanet.xyz) [![Discord](https://img.shields.io/discord/963778337904427018?color=green&logo=discord&logoColor=white&style=for-the-badge)](https://discord.gg/xp3vFSAMgS)
5+
[![Website](https://img.shields.io/badge/WEBSITE-https%3A%2F%2Fdocs.lavanet.xyz-green?style=for-the-badge)](https://docs.lavanet.xyz) <right> [![Discord](https://img.shields.io/discord/963778337904427018?color=green&logo=discord&logoColor=white&style=for-the-badge)](https://discord.gg/xp3vFSAMgS) </right>
66

77

88
## Overview 🔎
@@ -18,17 +18,13 @@ Contents include:
1818

1919
## Deployment 🚀
2020

21-
### Current Status
21+
### Status
2222

2323
[![Netlify Status](https://api.netlify.com/api/v1/badges/58c0a448-7af0-48d3-8e29-86fc4a6f4868/deploy-status)](https://app.netlify.com/sites/sage-swan-13ac7b/deploys)
2424

2525
### Process
2626
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.
2727

28-
## Community & Contribution 😻
29-
Contributing to the documentation of Lava is a rewarding way to give back to the ecosystem. We always welcome contributors with love & kindness. Please read the [contribution](CONTRIBUTING.md) guide to help you get started.
30-
31-
3228
## Local Development 🔧
3329

3430
### 1. Fork this repository!
@@ -42,7 +38,6 @@ SSH **(recommended)**
4238
```bash
4339
git clone [email protected]:Your-User-Name-Here/lava-docs.git
4440
```
45-
or
4641

4742
HTTPS
4843

@@ -69,11 +64,15 @@ Algolia search needs values assigned to these in order to start. For local docs
6964

7065
### 4. Install all packages
7166

72-
```yarn install```
67+
```
68+
yarn install
69+
```
7370

7471
### 5. Host a local preview of the docs (*Optional*)
7572

76-
```yarn start```
73+
```
74+
yarn start
75+
```
7776

7877
Your preview will dynamically change/hotload as you make changes to files.
7978

@@ -85,11 +84,14 @@ yarn build
8584

8685
Your build will appear in the `./build/` folder of your docs directory.
8786

88-
### 7. Deployment (*Optional*)
87+
### 7. Deploy to Github (*Optional*)
8988

9089
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.
9190

9291
```
9392
$ GIT_USER=<Your GitHub username> yarn deploy
9493
```
9594

95+
## Contribution 👥
96+
97+
Contributing to the documentation of Lava is a rewarding way to give back to the ecosystem. We always welcome contributors with love & kindness. Please read the [contribution](CONTRIBUTING.md) guide to help you get started.

0 commit comments

Comments
 (0)