likwid/docs/README.md

36 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

# Likwid Documentation
Welcome to the Likwid documentation. This guide covers everything you need to know to use and administer a Likwid instance.
## Documentation Structure
### For Users
- [Getting Started](user/getting-started.md) - First steps with Likwid
- [Communities](user/communities.md) - Creating and participating in communities
- [Proposals & Voting](user/voting.md) - Understanding the decision-making process
- [Delegation](user/delegation.md) - How liquid delegation works
- [Account Settings](user/settings.md) - Managing your account
### For System Administrators
- [Installation](admin/installation.md) - Deploying Likwid
- [Configuration](admin/configuration.md) - Server and instance settings
- [Database](admin/database.md) - PostgreSQL setup and maintenance
- [Plugins](admin/plugins.md) - Managing plugins and voting methods
- [Security](admin/security.md) - Security best practices
- [Backup & Recovery](admin/backup.md) - Data protection
### Reference
- [API Reference](reference/api.md) - REST API documentation
- [Voting Methods](reference/voting-methods.md) - Detailed voting algorithm explanations
- [Glossary](reference/glossary.md) - Terms and definitions
## Quick Links
- **Demo Instance**: Explore a live demo at `/demo`
- **Source Code**: [Codeberg](https://codeberg.org/likwid/likwid)
- **License**: EUPL-1.2
## Contributing
See [CONTRIBUTING.md](../CONTRIBUTING.md) for guidelines on contributing to Likwid.