From 8ad0ac8a7a9aafda6c96dc1daecbde18346733af Mon Sep 17 00:00:00 2001 From: Marco Allegretti Date: Thu, 29 Jan 2026 00:47:40 +0100 Subject: [PATCH] docs: align delegation scope and deployment guidance --- docs/README.md | 2 +- docs/admin/backup.md | 6 +++--- docs/admin/configuration.md | 1 + docs/admin/database.md | 2 +- docs/reference/glossary.md | 6 +++--- docs/user/delegation.md | 18 ++++++------------ docs/user/getting-started.md | 2 +- docs/user/voting.md | 2 +- 8 files changed, 17 insertions(+), 22 deletions(-) diff --git a/docs/README.md b/docs/README.md index 6804f03..93cb1b8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -28,7 +28,7 @@ Welcome to the Likwid documentation. This guide covers everything you need to kn - **Demo Instance**: Explore a live demo at `/demo` - **Source Code**: [Codeberg](https://codeberg.org/likwid/likwid) -- **License**: AGPLv3 +- **License**: EUPL-1.2 ## Contributing diff --git a/docs/admin/backup.md b/docs/admin/backup.md index 951629c..e7c4ba6 100644 --- a/docs/admin/backup.md +++ b/docs/admin/backup.md @@ -59,8 +59,8 @@ podman exec likwid-prod-db pg_dump -U likwid likwid_prod > backup.sql ```bash # Drop and recreate database -psql -h localhost -U postgres -c "DROP DATABASE IF EXISTS likwid_prod;" -psql -h localhost -U postgres -c "CREATE DATABASE likwid_prod OWNER likwid;" +psql -h localhost -U likwid -d postgres -c "DROP DATABASE IF EXISTS likwid_prod;" +psql -h localhost -U likwid -d postgres -c "CREATE DATABASE likwid_prod OWNER likwid;" # Restore from dump pg_restore -h localhost -U likwid -d likwid_prod backup.dump @@ -91,7 +91,7 @@ The demo instance can be reset to initial state: ./scripts/demo-reset.sh ``` -This removes all data and re-runs migrations with seed data. +This removes all demo data by recreating the demo database volume; on startup the backend runs core migrations and demo seed migrations to restore the initial demo dataset. ## Disaster Recovery Plan diff --git a/docs/admin/configuration.md b/docs/admin/configuration.md index 2cab7c6..d4d621c 100644 --- a/docs/admin/configuration.md +++ b/docs/admin/configuration.md @@ -21,6 +21,7 @@ Likwid is configured through environment variables and database settings. |----------|----------|---------|-------------| | `API_BASE` | No | `http://localhost:3000` | Backend API URL | | `PUBLIC_API_BASE` | No | Same as API_BASE | Public-facing API URL | +| `INTERNAL_API_BASE` | No | - | Server-side API URL (e.g. `http://backend:3000` in container deployments) | ## Instance Settings diff --git a/docs/admin/database.md b/docs/admin/database.md index 76dc754..356768c 100644 --- a/docs/admin/database.md +++ b/docs/admin/database.md @@ -49,7 +49,7 @@ sqlx migrate add | `delegations` | Delegation relationships | | `moderation_log` | Audit trail | | `comments` | Discussion comments | -| `topics` | Categorization for delegation | +| `topics` | Categorization for proposals | ## Backup diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md index aaac3be..21339d2 100644 --- a/docs/reference/glossary.md +++ b/docs/reference/glossary.md @@ -21,7 +21,7 @@ An option that would beat every other option in a head-to-head comparison. The S A user who receives delegated voting power from other users. ### Delegation -The act of entrusting your vote to another user. Can be topic-based or community-wide. +The act of entrusting your vote to another user. ### Deliberation The discussion phase of a proposal where members debate and refine ideas before voting. @@ -77,7 +77,7 @@ A voting method where voters rank options. Also called Instant Runoff Voting (IR A Condorcet voting method that uses pairwise comparisons and strongest paths to determine the winner. ### Scope -The extent of a delegation - can be community-wide or limited to specific topics. +The extent of a delegation - for example, global or community-wide. ### STAR Voting Score Then Automatic Runoff - voters rate options 0-5 stars, top two enter automatic runoff. @@ -85,7 +85,7 @@ Score Then Automatic Runoff - voters rate options 0-5 stars, top two enter autom ## T ### Topic -A category or subject area used to organize proposals and delegations. +A category or subject area used to organize proposals. ### Transitive Delegation When delegation chains are followed (A delegates to B, B delegates to C, so A's vote goes to C). diff --git a/docs/user/delegation.md b/docs/user/delegation.md index 133f8e1..e245ce5 100644 --- a/docs/user/delegation.md +++ b/docs/user/delegation.md @@ -14,22 +14,17 @@ Delegation allows you to entrust your vote to someone you trust, while retaining ### Community-Wide Your delegate votes on all proposals in a community. -### Topic-Based -Your delegate only votes on proposals tagged with specific topics: -- Architecture -- Budget -- Policy -- Security -- etc. +### Global +Your delegate votes on proposals across the instance. ## Creating a Delegation -1. Go to **Settings** → **Delegations** +1. Go to **Delegations** 2. Click **Add Delegation** 3. Select: - The delegate (user you trust) - The community - - The scope (all topics or specific topics) + - The scope (global or community) 4. Confirm ## Finding Delegates @@ -42,7 +37,7 @@ Look for users who: Delegate profiles show: - Their voting policy - Number of current delegators -- Topic expertise +- Areas of expertise ## Delegation Chains @@ -62,7 +57,7 @@ All delegations are visible: ## Revoking Delegation -1. Go to **Settings** → **Delegations** +1. Go to **Delegations** 2. Find the delegation to revoke 3. Click **Revoke** 4. The delegation ends immediately @@ -70,6 +65,5 @@ All delegations are visible: ## Best Practices - **Delegate to active members** who participate regularly -- **Use topic-based delegation** for specialized decisions - **Review your delegations** periodically - **Vote directly** on issues you care deeply about diff --git a/docs/user/getting-started.md b/docs/user/getting-started.md index 435fee9..f01294f 100644 --- a/docs/user/getting-started.md +++ b/docs/user/getting-started.md @@ -41,7 +41,7 @@ Before voting, read the full proposal text and deliberation history. Likwid enco ### 4. Participate - **Comment** on proposals during the discussion phase - **Vote** when voting opens -- **Delegate** your vote to trusted members on specific topics +- **Delegate** your vote to trusted members (globally or within a community) ## Understanding the Interface diff --git a/docs/user/voting.md b/docs/user/voting.md index 46343f7..24db0eb 100644 --- a/docs/user/voting.md +++ b/docs/user/voting.md @@ -70,7 +70,7 @@ The author creates a proposal with: ## Delegation and Voting -If you've delegated your vote on a topic: +If you've delegated your vote (globally or within a community): - Your delegate votes on your behalf - You can override by voting directly - Delegations are transparent