https://github.com/hiero-ledger/solo-docs
Solo is a command-line tool for deploying and managing Hedera network nodes and services on Kubernetes. This repository contains the official technical documentation site for Solo, built with Hugo and the Docsy theme.
https://github.com/hiero-ledger/solo-docs
documentation hugo solo
Last synced: 2 months ago
JSON representation
Solo is a command-line tool for deploying and managing Hedera network nodes and services on Kubernetes. This repository contains the official technical documentation site for Solo, built with Hugo and the Docsy theme.
- Host: GitHub
- URL: https://github.com/hiero-ledger/solo-docs
- Owner: hiero-ledger
- License: apache-2.0
- Created: 2026-02-26T19:55:22.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-04-13T16:55:42.000Z (2 months ago)
- Last Synced: 2026-04-13T17:35:05.126Z (2 months ago)
- Topics: documentation, hugo, solo
- Language: SCSS
- Homepage: https://hiero-ledger.github.io/solo-docs/
- Size: 2.8 MB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Maintainers: MAINTAINERS.md
Awesome Lists containing this project
README
# Solo Documentation Site
## What is Solo?
Solo is a command-line tool for deploying and managing Hedera network nodes and services on Kubernetes. This repository contains the official technical documentation site for Solo, built with Hugo and the Docsy theme.
The documentation covers:
- **Simple Setup**: Quick start guides for basic Solo deployments
- **Advanced Setup**: Complex network configurations and custom deployments
- **Using Solo**: Command reference and operational guides
- **Troubleshooting**: Common issues and solutions
## Quick Start
### Prerequisites
- Node.js 22+
- Go (for Hugo extended)
- Hugo extended 0.145.0+
### Build and Preview
1. Install dependencies:
```bash
npm install
```
2. Build the site:
```bash
hugo --cleanDestinationDir
```
3. Preview locally:
```bash
hugo server -D --baseURL http://localhost:1313/ --cleanDestinationDir
```
or simply
```bash
hugo serve
```
Open `http://localhost:1313/` in your browser.
## How to Contribute
We welcome contributions to improve the Solo documentation! Whether you're fixing typos, adding new guides, or improving existing content, here's how to get started:
### For Content Contributors
- **New to contributing?** Start with our [Contributing Guide](CONTRIBUTING.md)
- **Found an issue?** [Open an issue](https://github.com/hiero-ledger/solo-docs/issues) or submit a pull request
- **Need help?** Check our [troubleshooting guide](content/en/docs/troubleshooting.md)
### For Developers
- **Technical contributions**: See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup
- **Auto-generated content**: Documentation is automatically updated from Solo releases via GitHub Actions
## Documentation Structure
- `content/en/docs/` - Main documentation content
- `content/en/docs/simple-solo-setup/` - Getting started guides
- `content/en/docs/advanced-solo-setup/` - Advanced configuration
- `content/en/docs/using-solo/` - Usage and operations
- `content/en/docs/troubleshooting.md` - Common issues and solutions
## Deployment
The site is automatically deployed to [solo.hiero.org](https://solo.hiero.org/) when new Solo releases are published. Manual deployments can be triggered via GitHub Actions.
## Support
- **Documentation Issues**: [GitHub Issues](https://github.com/hiero-ledger/solo-docs/issues)
- **Solo Tool Issues**: [Solo Repository](https://github.com/hiero-ledger/solo)
- **Community**: Check our [community contributions](content/en/docs/community-contributions.md) guide