Skip to content

Commit 82158dc

Browse files
committed
Polish remaining documentation files for consistency
- CONTRIBUTING.md: Added horizontal rule separators between major sections, improved heading structure with better visual hierarchy, enhanced list formatting with proper introductory text - PROJECT_SUMMARY.md: Added section separators for better organization, improved consistency in formatting technical specifications - GETTING_STARTED.md: Enhanced step-by-step guide with clearer section breaks, standardized code block presentation, improved visual flow between sections All changes maintain consistent style with previously polished README.md and FAQ.md files, creating a cohesive documentation experience.
1 parent b581ff5 commit 82158dc

3 files changed

Lines changed: 91 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 49 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,24 @@
22

33
Thank you for your interest in contributing! This document provides guidelines and instructions for contributing to the OpenClaw Juju Charm project.
44

5+
---
6+
57
## Code of Conduct
68

9+
Be a good community member:
10+
711
- Be respectful and inclusive
812
- Focus on constructive feedback
913
- Help others learn and grow
1014

15+
---
16+
1117
## How to Contribute
1218

1319
### Reporting Bugs
1420

21+
Help us improve by reporting bugs:
22+
1523
1. Check if the bug is already reported in [Issues](https://github.com/fourdollars/openclaw-charm/issues)
1624
2. Create a new issue with:
1725
- Clear, descriptive title
@@ -22,12 +30,16 @@ Thank you for your interest in contributing! This document provides guidelines a
2230

2331
### Suggesting Enhancements
2432

33+
Have an idea? Let us know:
34+
2535
1. Open an issue with the "enhancement" label
2636
2. Describe the feature and use case
2737
3. Explain why it would be useful
2838

2939
### Pull Requests
3040

41+
Ready to contribute code?
42+
3143
1. Fork the repository
3244
2. Create a feature branch: `git checkout -b feature/amazing-feature`
3345
3. Make your changes
@@ -36,6 +48,8 @@ Thank you for your interest in contributing! This document provides guidelines a
3648
6. Push to your fork
3749
7. Open a pull request
3850

51+
---
52+
3953
### Development Setup
4054

4155
```bash
@@ -55,28 +69,38 @@ charmcraft pack
5569
juju deploy ./openclaw_*.charm --config test-config.yaml
5670
```
5771

72+
---
73+
5874
### Testing Guidelines
5975

76+
Ensure quality through thorough testing:
77+
6078
- Test all hooks (install, start, stop, config-changed, upgrade-charm)
6179
- Verify configuration changes work correctly
6280
- Test on both Jammy (22.04) and Noble (24.04)
6381
- Check logs for errors
6482
- Ensure service starts correctly
6583

84+
---
85+
6686
### Code Style
6787

68-
**Shell Scripts (Bash)**
88+
**Shell Scripts (Bash):**
89+
6990
- Use shellcheck for linting
7091
- Follow Google Shell Style Guide
7192
- Add comments for complex logic
7293
- Use meaningful variable names
7394
- Handle errors properly (set -e)
7495

75-
**YAML Files**
96+
**YAML Files:**
97+
7698
- 2-space indentation
7799
- Clear descriptions for all options
78100
- Follow Juju charm metadata standards
79101

102+
---
103+
80104
### Commit Messages
81105

82106
Follow [Conventional Commits](https://www.conventionalcommits.org/):
@@ -89,15 +113,21 @@ test: add upgrade test workflow
89113
chore: update dependencies
90114
```
91115

116+
---
117+
92118
### Pull Request Process
93119

120+
Follow these steps for a smooth review:
121+
94122
1. Update README.md if needed
95123
2. Update CHANGELOG.md
96124
3. Ensure all tests pass
97125
4. Request review from maintainers
98126
5. Address review feedback
99127
6. Squash commits if requested
100128

129+
---
130+
101131
## Project Structure
102132

103133
```
@@ -117,6 +147,8 @@ openclaw-charm/
117147
└── README.md # Main documentation
118148
```
119149

150+
---
151+
120152
## Testing
121153

122154
### Local Testing
@@ -144,17 +176,24 @@ juju ssh openclaw/0 'systemctl status openclaw'
144176
juju destroy-model test-openclaw -y
145177
```
146178

179+
---
180+
147181
### CI Testing
148182

149183
All PRs automatically run:
184+
150185
- Shell script linting
151186
- Metadata validation
152187
- Installation tests (npm/pnpm methods)
153188
- Configuration tests
154189
- Upgrade tests
155190

191+
---
192+
156193
## Release Process
157194

195+
Follow these steps for creating releases:
196+
158197
1. Update version in metadata
159198
2. Update CHANGELOG.md
160199
3. Create PR for release
@@ -166,21 +205,29 @@ All PRs automatically run:
166205
- Publish to CharmHub (candidate channel)
167206
- Create GitHub release
168207

208+
---
209+
169210
### Version Tags
170211

171212
- `vX.Y.Z` → candidate channel
172213
- `vX.Y.Z-rc.N` → beta channel
173214
- `vX.Y.Z-alpha.N` → edge channel
174215
- Stable channel requires manual approval
175216

217+
---
218+
176219
## Getting Help
177220

221+
Need assistance? Check these resources:
222+
178223
- **Documentation**: https://fourdollars.github.io/openclaw-charm/
179224
- **Issues**: https://github.com/fourdollars/openclaw-charm/issues
180225
- **Discussions**: https://github.com/fourdollars/openclaw-charm/discussions
181226
- **Juju Docs**: https://juju.is/docs
182227
- **OpenClaw Discord**: https://discord.gg/clawd
183228

229+
---
230+
184231
## License
185232

186233
By contributing, you agree that your contributions will be licensed under the MIT License.

GETTING_STARTED.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,19 @@
22

33
Your complete production-ready Juju machine charm for OpenClaw is ready!
44

5+
---
6+
57
## ✅ What's Been Created
68

79
### Core Charm Files
10+
811
-`metadata.yaml` - Charm definition (Noble 24.04)
912
-`config.yaml` - 18 configuration options
1013
-`charmcraft.yaml` - Build configuration
1114
-`hooks/` - Complete lifecycle management (install, start, stop, config-changed, upgrade-charm)
1215

1316
### GitHub Pages
17+
1418
-`docs/index.html` - Beautiful, modern documentation website
1519
- Animated gradient backgrounds
1620
- Responsive design
@@ -19,18 +23,21 @@ Your complete production-ready Juju machine charm for OpenClaw is ready!
1923
- Configuration reference
2024

2125
### CI/CD Workflows
26+
2227
-`.github/workflows/test.yaml` - Comprehensive testing (lint, install, channels, upgrade)
2328
-`.github/workflows/publish.yaml` - Automated CharmHub publishing
2429
-`.github/workflows/pages.yaml` - Documentation deployment
2530

2631
### Documentation
32+
2733
-`README.md` - Complete user documentation (10KB+)
2834
-`CONTRIBUTING.md` - Contribution guidelines
2935
-`LICENSE` - MIT License
3036
-`PROJECT_SUMMARY.md` - This summary
3137
- ✅ Issue & PR templates
3238

3339
### Quality Assurance
40+
3441
- ✅ All hooks pass shellcheck with zero errors
3542
- ✅ Validation script (`validate.sh`) for pre-deployment checks
3643
- ✅ 2,532 lines of production-ready code
@@ -40,28 +47,37 @@ Your complete production-ready Juju machine charm for OpenClaw is ready!
4047
## 🚀 Quick Start
4148

4249
### 1. Initialize Git Repository
50+
4351
```bash
4452
git init
4553
git add .
4654
git commit -m "Initial commit: OpenClaw Juju Charm v1.0.0"
4755
```
4856

57+
---
58+
4959
### 2. Create GitHub Repository
60+
5061
```bash
5162
# Create repo on GitHub, then:
5263
git remote add origin https://github.com/fourdollars/openclaw-charm.git
5364
git branch -M main
5465
git push -u origin main
5566
```
5667

68+
---
69+
5770
### 3. Enable GitHub Pages
71+
5872
1. Go to repository **Settings****Pages**
5973
2. Source: **Deploy from a branch**
6074
3. Branch: **main** → Directory: **/docs**
6175
4. Save
6276

6377
Your documentation will be live at: `https://fourdollars.github.io/openclaw-charm/`
6478

79+
---
80+
6581
### 4. Set Up CharmHub Publishing
6682

6783
**Register the charm:**
@@ -78,13 +94,17 @@ cat ~/charmcraft-token.txt # Copy this value
7894
```
7995

8096
**Add GitHub Secret:**
97+
8198
1. Go to repository **Settings****Secrets and variables****Actions**
8299
2. Click **New repository secret**
83100
3. Name: `CHARMCRAFT_TOKEN`
84101
4. Value: (paste token from above)
85102
5. Click **Add secret**
86103

104+
---
105+
87106
### 5. Test Locally (Optional but Recommended)
107+
88108
```bash
89109
# Install dependencies
90110
sudo snap install charmcraft --classic
@@ -114,7 +134,10 @@ juju destroy-model test-openclaw -y
114134
juju destroy-controller test-controller -y
115135
```
116136

137+
---
138+
117139
### 6. Publish to CharmHub
140+
118141
```bash
119142
# Create version tag
120143
git tag -a v1.0.0 -m "Release v1.0.0: Initial production release"
@@ -128,7 +151,10 @@ git push origin v1.0.0
128151
# 5. Create GitHub Release
129152
```
130153

154+
---
155+
131156
### 7. Verify Publication
157+
132158
```bash
133159
# Install from CharmHub
134160
juju deploy openclaw --channel=candidate \
@@ -145,11 +171,13 @@ juju status openclaw
145171
Share this with your users:
146172

147173
### Installation
174+
148175
```bash
149176
juju deploy openclaw --channel edge --config anthropic-api-key="your-key-here"
150177
```
151178

152179
### Configuration
180+
153181
```bash
154182
# Enable Telegram
155183
juju config openclaw telegram-bot-token="123456:ABC-DEF"
@@ -159,6 +187,7 @@ juju config openclaw discord-bot-token="YOUR.TOKEN.HERE"
159187
```
160188

161189
### Accessing Gateway
190+
162191
```bash
163192
# Get unit IP
164193
juju status openclaw

PROJECT_SUMMARY.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This project provides a complete, production-ready Juju machine charm for deploy
77
### ✅ Completed Components
88

99
#### 1. **Juju Machine Charm**
10+
1011
- **metadata.yaml**: Charm metadata with Noble 24.04 support and peer relations
1112
- **config.yaml**: 18 comprehensive configuration options covering:
1213
- AI providers (Anthropic, OpenAI, Bedrock, Ollama)
@@ -17,7 +18,10 @@ This project provides a complete, production-ready Juju machine charm for deploy
1718
- **charmcraft.yaml**: Build configuration for multi-base support
1819
- **Multi-unit architecture**: Automatic Gateway-Node deployment pattern
1920

21+
---
22+
2023
#### 2. **Charm Hooks**
24+
2125
All hooks are implemented, tested with shellcheck, and fully executable:
2226
- **install**: Installs Node.js, system dependencies, OpenClaw (npm/pnpm/source)
2327
- **start**: Role-aware startup (Gateway for leader, Node for non-leaders)
@@ -28,7 +32,10 @@ All hooks are implemented, tested with shellcheck, and fully executable:
2832
- **common.sh**: Shared functions including leader detection and role management
2933
- **Symlinks**: leader-elected → install, leader-settings-changed → config-changed, remove → stop
3034

35+
---
36+
3137
#### 3. **GitHub Pages Website**
38+
3239
Beautiful, modern documentation site at `docs/index.html`:
3340
- **Responsive design** with animated gradient background
3441
- **Feature showcase** with 9 feature cards
@@ -37,6 +44,8 @@ Beautiful, modern documentation site at `docs/index.html`:
3744
- **Modern UI**: Inter font, gradient text, glassmorphic cards
3845
- **Badges**: AI-Powered, 13+ Platforms, Self-Hosted, Production-Ready
3946

47+
---
48+
4049
#### 4. **GitHub Actions Workflows**
4150

4251
**test.yaml** - Comprehensive Testing:
@@ -63,10 +72,14 @@ Beautiful, modern documentation site at `docs/index.html`:
6372
- Comprehensive logging and status checks
6473

6574
**pages.yaml** - Documentation Deployment:
75+
6676
- Deploys GitHub Pages on docs/ changes
6777
- Automatic deployment to https://fourdollars.github.io/openclaw-charm/
6878

79+
---
80+
6981
#### 5. **Documentation**
82+
7083
- **README.md**: 10,828 bytes of comprehensive documentation
7184
- Quick start guide
7285
- Configuration reference table

0 commit comments

Comments
 (0)