Skip to content

Commit 0f494a2

Browse files
authored
Fix README
1 parent f3bb82f commit 0f494a2

File tree

1 file changed

+70
-20
lines changed

1 file changed

+70
-20
lines changed

README.md

Lines changed: 70 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,91 @@
1-
# Website
1+
# SSV Documentation Repository
22

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
3+
## 📖 Overview
44

5-
### Installation
5+
SSV (Secret Shared Validators) is a decentralized infrastructure that enables secure, fault-tolerant, and non-custodial staking on Ethereum. This documentation aims to provide:
66

7-
```
8-
$ yarn
9-
```
7+
- **Getting Started Guides** for developers, stakers, and operators.
8+
- **Technical Documentation** covering the SSV protocol, SDK, and Based Applications.
9+
- **Deployment Instructions** for setting up an SSV validator or operator.
10+
- **FAQ and Troubleshooting** to assist users in resolving common issues.
11+
12+
## 🚀 Running the Documentation Locally
13+
14+
The documentation is built using [Docusaurus](https://docusaurus.io/), a modern static site generator optimized for technical documentation.
15+
16+
### Prerequisites
17+
Ensure you have the following installed on your system:
1018

11-
### Local Development
19+
- [Node.js](https://nodejs.org/) (v16 or later recommended)
20+
- [Yarn](https://yarnpkg.com/) or npm
1221

22+
### Installation and Running Locally
23+
24+
Clone the repository and install dependencies:
25+
26+
```bash
27+
# Clone the repository
28+
git clone https://github.com/ssvlabs/gitbook-docs.git
29+
cd ssv-docs
30+
31+
# Install dependencies
32+
yarn install # or npm install
1333
```
14-
$ yarn start
34+
35+
To start a local development server with hot-reloading:
36+
37+
```bash
38+
yarn start # or npm run start
1539
```
1640

17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
41+
This will launch the documentation site in your default browser, typically available at `http://localhost:3000/`.
1842

19-
### Build
43+
To build the static site for deployment:
2044

21-
```
22-
$ yarn build
45+
```bash
46+
yarn build # or npm run build
2347
```
2448

25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
49+
## 🛠 Contributing
2650

27-
### Deployment
51+
We welcome contributions to improve the documentation! Follow these steps to contribute:
2852

29-
Using SSH:
53+
### 1. Fork & Clone
54+
Fork this repository and clone it to your local machine:
3055

31-
```
32-
$ USE_SSH=true yarn deploy
56+
```bash
57+
git clone https://github.com/your-username/ssv-docs.git
58+
cd ssv-docs
3359
```
3460

35-
Not using SSH:
61+
### 2. Create a Branch
62+
Create a new branch for your changes:
3663

64+
```bash
65+
git checkout -b feature/update-docs
3766
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
67+
68+
### 3. Make Changes
69+
- Edit the relevant Markdown (`.md`) files inside the `docs/` directory.
70+
- If modifying the sidebar or navigation, update `sidebars.js`.
71+
- Ensure proper formatting and clarity.
72+
73+
### 4. Commit & Push
74+
Commit your changes and push to your fork:
75+
76+
```bash
77+
git add .
78+
git commit -m "Update documentation on X feature"
79+
git push origin feature/update-docs
3980
```
4081

41-
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.
82+
### 5. Open a Pull Request
83+
Go to the original repository and submit a pull request with a clear description of your changes.
84+
85+
## 📢 Community & Support
86+
For any questions, feel free to reach out:
87+
88+
- Join the [SSV Network Discord](https://discord.com/invite/ssvnetworkofficial)
89+
- Open an issue on this repo
90+
91+
Thank you for contributing to SSV Docs! 🚀

0 commit comments

Comments
 (0)