Skip to content

Commit 4e60267

Browse files
committed
docs: overhaul README.md for clarity and structure
- Expanded the introduction to provide a clearer overview of Powerloom. - Added sections for Quick Start, Development, Project Structure, Key Features, Contributing, and Troubleshooting. - Updated installation and deployment instructions for better usability. - Included environment variable configuration and resources for users.
1 parent 110186d commit 4e60267

1 file changed

Lines changed: 116 additions & 16 deletions

File tree

README.md

Lines changed: 116 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,141 @@
1-
# Powerloom Docs
1+
# Powerloom Documentation
22

3-
This is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
3+
Official documentation for Powerloom - The Decentralized Data Protocol
4+
5+
[View Documentation](https://docs.powerloom.io) | [Discord](https://discord.com/invite/powerloom) | [Twitter](https://twitter.com/PowerLoomHQ)
6+
7+
## About
8+
9+
This repository contains the official documentation for Powerloom, a decentralized data protocol that enables developers to build data-driven applications with verifiable, real-time data.
10+
11+
## Quick Start
12+
13+
### Prerequisites
14+
15+
- Node.js ≥ 20.0.0
16+
- Yarn package manager
417

518
### Installation
619

7-
```
8-
$ yarn
20+
```bash
21+
# Clone the repository
22+
git clone https://github.com/Powerloom/docs.git
23+
cd docs
24+
25+
# Install dependencies
26+
yarn install --frozen-lockfile
927
```
1028

11-
### Local Development
29+
### Development
1230

13-
```
14-
$ yarn start
31+
```bash
32+
# Start the development server
33+
yarn start
34+
35+
# The site will be available at http://localhost:3000
1536
```
1637

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.
38+
The development server features hot reloading - most changes are reflected immediately without restarting.
1839

1940
### Build
2041

42+
```bash
43+
# Create production build
44+
yarn build
45+
46+
# Test the production build locally
47+
yarn serve
48+
```
49+
50+
## Project Structure
51+
2152
```
22-
$ yarn build
53+
docs/
54+
├── docs/ # Documentation content
55+
│ ├── Protocol/ # Protocol specifications
56+
│ ├── build-with-powerloom/ # Developer guides
57+
│ ├── chain-migration/ # V1 to V2 migration guides
58+
│ └── participate/ # Network participation guides
59+
├── src/ # Custom React components
60+
├── static/ # Static assets (images, files)
61+
├── docusaurus.config.js # Site configuration
62+
└── sidebars.js # Navigation structure
2363
```
2464

25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
65+
## Key Features
66+
67+
- **Fast Builds**: Powered by Docusaurus 3.8.1 with experimental Rspack bundler
68+
- **Full-Text Search**: Integrated Typesense search for instant results
69+
- **Dark Mode**: Automatic theme switching based on system preferences
70+
- **MDX Support**: Enhanced Markdown with React components
71+
72+
## Contributing
2673

27-
### Deployment
74+
We welcome contributions to improve our documentation!
2875

29-
Using SSH:
76+
### Documentation Guidelines
3077

78+
- Use clear, concise language
79+
- Include code examples where applicable
80+
- Add screenshots for UI-related content
81+
- Cross-reference related topics with links
82+
- Follow the existing file structure
83+
84+
### Commit Convention
85+
86+
We use conventional commits:
87+
- `feat:` New documentation or features
88+
- `fix:` Corrections to existing docs
89+
- `chore:` Maintenance tasks
90+
- `docs:` Documentation-only changes
91+
92+
## Configuration
93+
94+
### Environment Variables
95+
96+
Create a `.env` file for local configuration:
97+
98+
```bash
99+
# Typesense Search (optional)
100+
TYPESENSE_API_KEY=your_api_key
101+
TYPESENSE_HOST=your_host
31102
```
32-
$ USE_SSH=true yarn deploy
103+
104+
## Deployment
105+
106+
The documentation is automatically deployed via GitHub Actions on merges to `main`.
107+
108+
### Manual Deployment
109+
110+
For GitHub Pages deployment:
111+
112+
```bash
113+
# Using SSH
114+
USE_SSH=true yarn deploy
115+
116+
# Using HTTPS
117+
GIT_USER=<Your GitHub username> yarn deploy
33118
```
34119

35-
Not using SSH:
120+
## Troubleshooting
36121

122+
**Build fails with memory error**
123+
```bash
124+
NODE_OPTIONS="--max-old-space-size=4096" yarn build
37125
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
126+
127+
**Port 3000 already in use**
128+
```bash
129+
yarn start --port 3001
39130
```
40131

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.
132+
## Resources
133+
134+
- **Live Documentation**: https://docs.powerloom.io
135+
- **Powerloom Website**: https://powerloom.io
136+
- **GitHub**: https://github.com/Powerloom
137+
- **Discord Community**: https://discord.com/invite/powerloom
138+
139+
## License
140+
141+
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)