192 Commits

Author SHA1 Message Date
6c7d8d382b getting_started: rewrite "Identifying to the bot" and "Loading Plugins" sections
- Move NickAuth before hostmask login - NickAuth is more straightforward to configure and less easy to mess up (e.g. by adding an overly wide hostmask)
- Make the Loading Plugins section more straightforward, and add links to plugin listings

Note that I removed the part where nested commands ("[hostmask]") are mentioned in passing. This is a complicated and interesting enough topic to deserve its own page.
2025-02-04 08:57:58 +01:00
8b4b145d6b Rewrite the Capabilities reference
- Focus more on the format and usage of capabilities, as opposed to the excitement and motivation
- Change "Default capabilities" to "Special built-in capabilities" to avoid confusion with "defaultcapability add|remove"
- Split the documentation for each built-in capability into a separate section for readability
- Add specific entries for #channel,halfop and #channel,voice instead of mentioning only them in passing in a command usage example
- Flip the ordering for global and channel default capabilities. The former is IMO more likely to be more useful
2025-02-04 08:53:29 +01:00
f8fc966d98 configuration: reorder editing config manually section
It's better to disable flushing first, rather than risk having your changes overwritten...
2025-02-03 21:39:40 -08:00
947e800fbb configuration: clarify meaning of botname.conf
The .conf file is always used to start the bot - whether it comes from supybot-wizard is a less important detail.
2025-02-03 19:49:42 -08:00
a176335e84 Rewrite the Configuration guide
Rewrite the Configuration guide to be more concise, and display lists in bullet form (instead of prose) for better readability.

I've also added a couple more notes:
- How to get the path of a config option from the results of looking through `config list`, in case it isn't obvious
- A quick description of the `config reset channel` and `config reset network` commands
2025-02-03 18:36:05 +01:00
5a93c9bfc5 Replace Supybook references with the Getting Started guide
Supybook's last update was over 10 years ago. While it still includes some nice tips I think it's more natural to have the documentaiton be self-contained.
2025-01-21 09:06:15 +01:00
a6319311f4 getting_started: cleanup and revise lead section
- Remove the `supybot-wizard` section, as this is duplicated with the install guides
- Add a short blurb describing how to interact with the bot (via command prefix, nick prefix, or direct message)
- Add an explanation of *why* "list" and "help" are separate commands.
- Use consistent formatting when referring to command names. (in this case I used code blocks)
2025-01-21 09:05:34 +01:00
fc5f96de8c use/install: Remove --user
It has not been needed for a while, and fails when a venv is active.
2024-11-13 18:19:51 +01:00
f653e6a328 Update references to the default peekSize 2024-07-27 12:07:34 +02:00
b59129240b Remove references to the 'testing' branch 2024-07-16 18:37:09 +02:00
1e9d3e3419 Update capitalization in repo URL 2024-07-16 18:36:58 +02:00
048aeebc57 Youtube added even more Javascript in their HTML 2024-06-20 19:11:26 +02:00
16f57b4598 Remove GPG from the Getting Started guide
No one uses it, and it's just confusing
2024-06-15 08:18:17 +02:00
806cc51199 install_windows: remove unnecessary intro text 2024-06-14 21:44:48 -07:00
e82d9c3dff Document network-specific configuration values 2023-07-28 18:55:27 +02:00
3ef90ae6cf systemd: Default to /usr/bin/supybot 2023-06-10 16:43:23 +02:00
ea060a65d5 install & systemd: Mention how to setup with a virtualenv 2023-06-10 16:43:23 +02:00
b5097cd05d install: Remove references to FreeBSD ports
According to https://www.freshports.org/irc/py-limnoria/ they are still
shipping version 2019.09.08 on some architectures, and it's vulnerable
to CVE-2019-19010.
2023-04-26 17:56:01 +02:00
feca77cf8b install_windows: Update and clarify Python versions 2023-03-15 08:33:26 +01:00
b050aaeb68 Make it clearer supybot-botchk can be used on distribs without systemd 2022-09-13 21:45:01 +02:00
b14e7c75b5 install: Fix AUR links again 2022-07-29 21:12:03 +02:00
d312e1611c install: Fix AUR links 2022-07-29 18:53:16 +02:00
d4860a6677 install: Remove details about installing python and distutils
They are not useful anymore.
2022-05-11 23:18:23 +02:00
aa3151a5e8 install: Remove section on installing from ZIPs
I don't see any reason to use ZIPs instead of pip anymore.
2022-05-11 22:58:47 +02:00
c63127b7b6 install: Make section on package managers more compact
The long descriptions made sense when Limnoria was missing from most
recent versions of distributions, but now it is a waste of visual space,
and intimidates newcomers.
2022-05-11 22:56:36 +02:00
15767c4e5b Remove dead link 2022-05-11 21:58:11 +02:00
5b1669b461 Rename 'Supybot' to 'Limnoria' in introductory material
At this point, it's just confusing to keep refering to Supybot,
especially for new users.
2022-05-11 21:57:25 +02:00
b4b52e2c7c Reference modern-irc spec when relevant 2022-03-17 21:31:55 +01:00
9b696f1ad3 faq: Fix typo in addr:port syntax 2022-03-14 19:21:17 +01:00
68bee8234b install docs for #98 2022-02-02 08:55:07 +01:00
a9323800b8 faq: Bump the suggested value for peekSize
Youtube added even more bloat to its pages, I need 191kB right now.
2021-12-28 23:43:52 +01:00
3a1c8f5884 faq: Explicitly define anchors 2021-12-28 23:39:25 +01:00
6b4fbc78b0 faq: Remove outdated item 2021-12-28 23:39:15 +01:00
604de68302 Move FAQ item to the right page. 2021-12-28 23:38:53 +01:00
02e8b2ab1f use/faq: Add two item about the title snarfer 2021-12-18 18:44:41 +01:00
1bbf81b42d use/botchk: Don't override the PATH, that's useless. 2021-12-18 18:44:22 +01:00
e0565fde82 use/security: Remove commit number, just use the version 2021-12-18 18:44:02 +01:00
073b6b3b0d install guide: remove irrelevant/outdated info 2021-10-28 23:14:26 +02:00
353dcd39fd format 'supybot-wizard' as monospace 2021-09-20 18:39:54 +02:00
4833ba4030 Fix command for NickServ registration on old bots 2021-09-07 22:46:09 +02:00
dc97a84f30 Freenode -> Libera
Signed-off-by: Georg <georg@lysergic.dev>
2021-07-17 20:44:55 +02:00
1c74260111 faq.rst: use example.com instead of my.host.com 2021-06-29 17:41:51 +02:00
ff7432f929 update links http -> https & fix linkrots 2021-06-29 17:41:51 +02:00
cca2fd6eb3 install: fix link to Supybook 2021-06-29 17:41:51 +02:00
371de50277 security.rst: add status.commands and partmsg 2021-06-29 17:35:18 +02:00
271132c215 identifying_to_services.rst: update Services to config.network era 2021-06-23 09:42:29 +02:00
09943ffc54 identifying_to_services: Change commands to work around Charybdis/Solanum's differing protocol 2021-06-17 19:57:54 +02:00
27321d3782 Mention how /nickserv is a common but not universal alias
Closes GH-82.
2021-05-22 15:01:54 -07:00
74baa551f1 Update Arch Linux & FreeBSD instructions 2021-05-22 14:18:34 -07:00
327b3a0762 security: fix formatting of systemd hardening example 2021-05-22 13:55:09 -07:00