From 59b7ee7115f40db2c7696089738eb913092487ad Mon Sep 17 00:00:00 2001 From: Pragmatic Software Date: Sat, 19 Aug 2023 16:44:26 -0700 Subject: [PATCH] docs: Fix broken link; describe user-capability groups as "roles" --- README.md | 4 ++-- doc/Admin.md | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 67373b09..181b9bec 100644 --- a/README.md +++ b/README.md @@ -272,7 +272,7 @@ Applet | Description [C-to-English translator](applets/c2english) | Translates C code to natural English sentences. [C precedence analyzer](applets/paren) | Adds parentheses to C code to demonstrate precedence. [C Jeopardy! game](applets/cjeopardy) | C programming trivia game based on the Jeopardy! TV game show. -[C Standard citations](applets/c11std.pl) | Cite specified sections/paragraphs from the C standard. +[C Standard citations](applets/cstd.pl) | Cite specified sections/paragraphs from the C standard. [Virtual machine](applets/pbot-vm) | Executes arbitrary code and commands within a virtual machine. [dict.org Dictionary](applets/dict.org.pl) | Interface to dict.org for definitions, translations, acronyms, etc. [Urban Dictionary](applets/urban) | Search Urban Dictionary for definitions. @@ -362,7 +362,7 @@ For more information about the virtual machine, see the [Virtual Machine documen ### Powerful user management PBot has powerful yet simple user management functionality and commands. -* instead of generic access-levels, [fine-grained user capabilities](doc/Admin.md#user-capabilities) limit what users may do +* instead of generic access-levels, PBot uses [fine-grained user capabilities](doc/Admin.md#user-capabilities), which can be grouped into roles such as Admin, ChanOp, Moderator, etc * user accounts can be global or channel-specific * users can be recognized by hostmask or required to login with password * users can adjust their [user-metadata](doc/Admin.md#user-metadata-list) with the [`my`](doc/Commands.md#my) command diff --git a/doc/Admin.md b/doc/Admin.md index c4683933..337b275e 100644 --- a/doc/Admin.md +++ b/doc/Admin.md @@ -165,7 +165,8 @@ list all users from all channels, including global users. ## User capabilities PBot uses a user-capability system to control what users can and cannot do. User-capabilities -provides fine-grained permissions over various PBot functionality. +provides fine-grained permissions over various PBot functionality. User-capabilities may be +grouped into roles such as Admin, ChanOp, Moderator, and other user-defined roles. ### Introduction For example, imagine a user named alice. alice has no capabilities granted yet. @@ -238,7 +239,7 @@ If `[capability]` is omitted, the command will list all available capabilities. #### Grouping capabilities -Capabilities can be grouped together into a collection, which can then be applied to a user. +Capabilities can be grouped together into a collection or role, which can then be applied to a user. Capability groups can contain nested groups. In the [listing capabilities](#listing-capabilities) example, the `admin` capability is