mirror of
https://codeberg.org/likwid/likwid.git
synced 2026-06-25 15:37:42 +00:00
355 lines
10 KiB
Text
355 lines
10 KiB
Text
|
---
|
||
|
|
import PublicLayout from '../layouts/PublicLayout.astro';
|
||
|
|
---
|
||
|
|
|
||
|
|
<PublicLayout title="Documentation" description="Technical documentation for Likwid: deployment guides, API reference, plugin development, and administration.">
|
||
|
|
<article class="docs-page">
|
||
|
|
<header class="page-header">
|
||
|
|
<h1>Documentation</h1>
|
||
|
|
<p class="lead">
|
||
|
|
Technical guides for deploying, configuring, and extending Likwid.
|
||
|
|
</p>
|
||
|
|
</header>
|
||
|
|
|
||
|
|
<section class="docs-sections">
|
||
|
|
<div class="doc-category">
|
||
|
|
<div class="category-header">
|
||
|
|
<div class="category-icon">🚀</div>
|
||
|
|
<h2>Getting Started</h2>
|
||
|
|
</div>
|
||
|
|
<div class="doc-list">
|
||
|
|
<a href="/docs/quickstart" class="doc-link">
|
||
|
|
<h4>Quick Start Guide</h4>
|
||
|
|
<p>Deploy Likwid in 10 minutes using Docker/Podman compose.</p>
|
||
|
|
</a>
|
||
|
|
<a href="/docs/requirements" class="doc-link">
|
||
|
|
<h4>System Requirements</h4>
|
||
|
|
<p>Hardware, software, and network requirements for production deployment.</p>
|
||
|
|
</a>
|
||
|
|
<a href="/docs/installation" class="doc-link">
|
||
|
|
<h4>Installation Guide</h4>
|
||
|
|
<p>Step-by-step installation for various environments and configurations.</p>
|
||
|
|
</a>
|
||
|
|
<a href="/docs/first-community" class="doc-link">
|
||
|
|
<h4>Creating Your First Community</h4>
|
||
|
|
<p>Set up a community, configure governance, and invite members.</p>
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="doc-category">
|
||
|
|
<div class="category-header">
|
||
|
|
<div class="category-icon">⚙️</div>
|
||
|
|
<h2>Administration</h2>
|
||
|
|
</div>
|
||
|
|
<div class="doc-list">
|
||
|
|
<a href="/docs/admin/instance" class="doc-link">
|
||
|
|
<h4>Instance Administration</h4>
|
||
|
|
<p>Platform settings, plugin management, and global configuration.</p>
|
||
|
|
</a>
|
||
|
|
<a href="/docs/admin/communities" class="doc-link">
|
||
|
|
<h4>Community Management</h4>
|
||
|
|
<p>Create communities, manage roles, and configure governance settings.</p>
|
||
|
|
</a>
|
||
|
|
<a href="/docs/admin/moderation" class="doc-link">
|
||
|
|
<h4>Moderation Tools</h4>
|
||
|
|
<p>Configure moderation policies, manage the moderation ledger, and handle appeals.</p>
|
||
|
|
</a>
|
||
|
|
<a href="/docs/admin/backup" class="doc-link">
|
||
|
|
<h4>Backup & Recovery</h4>
|
||
|
|
<p>Database backups, disaster recovery, and data migration.</p>
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="doc-category">
|
||
|
|
<div class="category-header">
|
||
|
|
<div class="category-icon">🗳️</div>
|
||
|
|
<h2>Governance Features</h2>
|
||
|
|
</div>
|
||
|
|
<div class="doc-list">
|
||
|
|
<a href="/docs/governance/voting-methods" class="doc-link">
|
||
|
|
<h4>Voting Methods</h4>
|
||
|
|
<p>Configure and use Schulze, STAR, Quadratic, Ranked Choice, and Approval voting.</p>
|
||
|
|
</a>
|
||
|
|
<a href="/docs/governance/delegation" class="doc-link">
|
||
|
|
<h4>Liquid Delegation</h4>
|
||
|
|
<p>Set up topic-based delegation, trust networks, and delegation policies.</p>
|
||
|
|
</a>
|
||
|
|
<a href="/docs/governance/deliberation" class="doc-link">
|
||
|
|
<h4>Structured Deliberation</h4>
|
||
|
|
<p>Configure Inform→Discuss→Decide workflows and facilitator tools.</p>
|
||
|
|
</a>
|
||
|
|
<a href="/docs/governance/proposals" class="doc-link">
|
||
|
|
<h4>Proposal Lifecycle</h4>
|
||
|
|
<p>Create, manage, and track proposals through their governance journey.</p>
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="doc-category">
|
||
|
|
<div class="category-header">
|
||
|
|
<div class="category-icon">🔌</div>
|
||
|
|
<h2>Plugin Development</h2>
|
||
|
|
</div>
|
||
|
|
<div class="doc-list">
|
||
|
|
<a href="/docs/plugins/overview" class="doc-link">
|
||
|
|
<h4>Plugin Architecture</h4>
|
||
|
|
<p>Understand Likwid's plugin system, hooks, and extension points.</p>
|
||
|
|
</a>
|
||
|
|
<a href="/docs/plugins/creating" class="doc-link">
|
||
|
|
<h4>Creating Plugins</h4>
|
||
|
|
<p>Step-by-step guide to building your first Likwid plugin.</p>
|
||
|
|
</a>
|
||
|
|
<a href="/docs/plugins/voting" class="doc-link">
|
||
|
|
<h4>Voting Method Plugins</h4>
|
||
|
|
<p>Implement custom voting methods with the voting plugin API.</p>
|
||
|
|
</a>
|
||
|
|
<a href="/docs/plugins/integrations" class="doc-link">
|
||
|
|
<h4>Integration Plugins</h4>
|
||
|
|
<p>Connect Likwid to external services: GitLab, Matrix, webhooks, and more.</p>
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="doc-category">
|
||
|
|
<div class="category-header">
|
||
|
|
<div class="category-icon">📡</div>
|
||
|
|
<h2>API Reference</h2>
|
||
|
|
</div>
|
||
|
|
<div class="doc-list">
|
||
|
|
<a href="/docs/api/overview" class="doc-link">
|
||
|
|
<h4>API Overview</h4>
|
||
|
|
<p>Authentication, rate limiting, and general API conventions.</p>
|
||
|
|
</a>
|
||
|
|
<a href="/docs/api/communities" class="doc-link">
|
||
|
|
<h4>Communities API</h4>
|
||
|
|
<p>Endpoints for community management and configuration.</p>
|
||
|
|
</a>
|
||
|
|
<a href="/docs/api/proposals" class="doc-link">
|
||
|
|
<h4>Proposals API</h4>
|
||
|
|
<p>Create, update, and manage proposals programmatically.</p>
|
||
|
|
</a>
|
||
|
|
<a href="/docs/api/voting" class="doc-link">
|
||
|
|
<h4>Voting API</h4>
|
||
|
|
<p>Cast votes, retrieve results, and manage voting sessions.</p>
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="doc-category">
|
||
|
|
<div class="category-header">
|
||
|
|
<div class="category-icon">🔒</div>
|
||
|
|
<h2>Security</h2>
|
||
|
|
</div>
|
||
|
|
<div class="doc-list">
|
||
|
|
<a href="/docs/security/overview" class="doc-link">
|
||
|
|
<h4>Security Overview</h4>
|
||
|
|
<p>Security model, threat considerations, and best practices.</p>
|
||
|
|
</a>
|
||
|
|
<a href="/docs/security/authentication" class="doc-link">
|
||
|
|
<h4>Authentication</h4>
|
||
|
|
<p>Configure authentication methods, SSO, and OAuth providers.</p>
|
||
|
|
</a>
|
||
|
|
<a href="/docs/security/audit-trail" class="doc-link">
|
||
|
|
<h4>Audit Trail</h4>
|
||
|
|
<p>Understanding the cryptographic moderation ledger and verification.</p>
|
||
|
|
</a>
|
||
|
|
<a href="/docs/security/privacy" class="doc-link">
|
||
|
|
<h4>Privacy & Identity</h4>
|
||
|
|
<p>Civic vs. voting identities, data protection, and privacy controls.</p>
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<section class="docs-notice">
|
||
|
|
<div class="notice-content">
|
||
|
|
<h3>Documentation In Progress</h3>
|
||
|
|
<p>
|
||
|
|
Likwid is under active development and documentation is being written alongside the codebase.
|
||
|
|
Some sections may be incomplete or subject to change. For the latest information, see the
|
||
|
|
<a href="https://codeberg.org/likwid/likwid" target="_blank" rel="noopener">Codeberg repository</a>.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<section class="docs-contribute">
|
||
|
|
<h2>Contributing to Documentation</h2>
|
||
|
|
<p>
|
||
|
|
Found an error? Want to add a section? Documentation contributions are welcome.
|
||
|
|
</p>
|
||
|
|
<div class="contribute-links">
|
||
|
|
<a href="https://github.com/likwid-governance/likwid/tree/main/docs" target="_blank" rel="noopener" class="contribute-link">
|
||
|
|
View on GitHub
|
||
|
|
</a>
|
||
|
|
<a href="/contributing" class="contribute-link">
|
||
|
|
Contribution Guidelines
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</article>
|
||
|
|
</PublicLayout>
|
||
|
|
|
||
|
|
<style>
|
||
|
|
.docs-page {
|
||
|
|
max-width: 1000px;
|
||
|
|
margin: 0 auto;
|
||
|
|
padding: 0 2rem;
|
||
|
|
}
|
||
|
|
|
||
|
|
.page-header {
|
||
|
|
text-align: center;
|
||
|
|
padding: 3rem 0 4rem;
|
||
|
|
border-bottom: 1px solid var(--color-border);
|
||
|
|
}
|
||
|
|
|
||
|
|
.page-header h1 {
|
||
|
|
font-size: 2.5rem;
|
||
|
|
font-weight: 700;
|
||
|
|
margin-bottom: 1rem;
|
||
|
|
}
|
||
|
|
|
||
|
|
.lead {
|
||
|
|
font-size: 1.25rem;
|
||
|
|
color: var(--color-text-muted);
|
||
|
|
max-width: 500px;
|
||
|
|
margin: 0 auto;
|
||
|
|
line-height: 1.6;
|
||
|
|
}
|
||
|
|
|
||
|
|
.docs-sections {
|
||
|
|
padding: 2rem 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
.doc-category {
|
||
|
|
margin-bottom: 3rem;
|
||
|
|
}
|
||
|
|
|
||
|
|
.category-header {
|
||
|
|
display: flex;
|
||
|
|
align-items: center;
|
||
|
|
gap: 1rem;
|
||
|
|
margin-bottom: 1.5rem;
|
||
|
|
padding-bottom: 1rem;
|
||
|
|
border-bottom: 1px solid var(--color-border);
|
||
|
|
}
|
||
|
|
|
||
|
|
.category-icon {
|
||
|
|
font-size: 1.5rem;
|
||
|
|
}
|
||
|
|
|
||
|
|
.category-header h2 {
|
||
|
|
font-size: 1.5rem;
|
||
|
|
font-weight: 600;
|
||
|
|
margin: 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
.doc-list {
|
||
|
|
display: grid;
|
||
|
|
grid-template-columns: repeat(2, 1fr);
|
||
|
|
gap: 1rem;
|
||
|
|
}
|
||
|
|
|
||
|
|
@media (max-width: 768px) {
|
||
|
|
.doc-list {
|
||
|
|
grid-template-columns: 1fr;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
.doc-link {
|
||
|
|
display: block;
|
||
|
|
padding: 1.25rem;
|
||
|
|
background: var(--color-surface);
|
||
|
|
border: 1px solid var(--color-border);
|
||
|
|
border-radius: var(--radius-md);
|
||
|
|
text-decoration: none;
|
||
|
|
transition: all var(--motion-fast) var(--easing-standard);
|
||
|
|
}
|
||
|
|
|
||
|
|
.doc-link:hover {
|
||
|
|
border-color: var(--color-primary);
|
||
|
|
transform: translateY(-1px);
|
||
|
|
}
|
||
|
|
|
||
|
|
.doc-link h4 {
|
||
|
|
font-size: 1rem;
|
||
|
|
color: var(--color-text);
|
||
|
|
margin-bottom: 0.375rem;
|
||
|
|
}
|
||
|
|
|
||
|
|
.doc-link p {
|
||
|
|
color: var(--color-text-muted);
|
||
|
|
font-size: 0.875rem;
|
||
|
|
margin: 0;
|
||
|
|
line-height: 1.4;
|
||
|
|
}
|
||
|
|
|
||
|
|
.docs-notice {
|
||
|
|
padding: 2rem 0;
|
||
|
|
border-top: 1px solid var(--color-border);
|
||
|
|
}
|
||
|
|
|
||
|
|
.notice-content {
|
||
|
|
background: var(--color-info-muted);
|
||
|
|
border: 1px solid var(--color-info);
|
||
|
|
border-radius: var(--radius-md);
|
||
|
|
padding: 1.5rem;
|
||
|
|
}
|
||
|
|
|
||
|
|
.notice-content h3 {
|
||
|
|
font-size: 1rem;
|
||
|
|
color: var(--color-info);
|
||
|
|
margin-bottom: 0.5rem;
|
||
|
|
}
|
||
|
|
|
||
|
|
.notice-content p {
|
||
|
|
color: var(--color-text-muted);
|
||
|
|
font-size: 0.9375rem;
|
||
|
|
margin: 0;
|
||
|
|
line-height: 1.6;
|
||
|
|
}
|
||
|
|
|
||
|
|
.notice-content a {
|
||
|
|
color: var(--color-info);
|
||
|
|
}
|
||
|
|
|
||
|
|
.docs-contribute {
|
||
|
|
padding: 2rem 0 3rem;
|
||
|
|
text-align: center;
|
||
|
|
border-top: 1px solid var(--color-border);
|
||
|
|
}
|
||
|
|
|
||
|
|
.docs-contribute h2 {
|
||
|
|
font-size: 1.5rem;
|
||
|
|
margin-bottom: 0.75rem;
|
||
|
|
}
|
||
|
|
|
||
|
|
.docs-contribute > p {
|
||
|
|
color: var(--color-text-muted);
|
||
|
|
margin-bottom: 1.5rem;
|
||
|
|
}
|
||
|
|
|
||
|
|
.contribute-links {
|
||
|
|
display: flex;
|
||
|
|
gap: 1rem;
|
||
|
|
justify-content: center;
|
||
|
|
flex-wrap: wrap;
|
||
|
|
}
|
||
|
|
|
||
|
|
.contribute-link {
|
||
|
|
display: inline-block;
|
||
|
|
padding: 0.75rem 1.5rem;
|
||
|
|
background: var(--color-surface);
|
||
|
|
border: 1px solid var(--color-border);
|
||
|
|
border-radius: var(--radius-md);
|
||
|
|
font-weight: 500;
|
||
|
|
transition: all var(--motion-fast) var(--easing-standard);
|
||
|
|
}
|
||
|
|
|
||
|
|
.contribute-link:hover {
|
||
|
|
border-color: var(--color-primary);
|
||
|
|
color: var(--color-primary);
|
||
|
|
}
|
||
|
|
</style>
|