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
8ce98eb38c
Actually they are called after updating IrcState
2024-02-13 21:22:06 +01:00
46fa8ec799
Mention that do-methods are called before updating IrcState
2024-02-13 21:19:28 +01:00
e82d9c3dff
Document network-specific configuration values
2023-07-28 18:55:27 +02:00
ebb19029e6
using_wrap: Fix definition-list formatting
2023-06-10 16:45:16 +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
7cc6b1f9f8
Apply suggestions from code review
...
Co-authored-by: Val Lorentz <progval+git@progval.net>
2023-05-11 08:08:52 -07:00
b0c881f41b
plugin_tutorial: consistently use the decorator @wrap syntax
2023-05-11 08:08:52 -07:00
007b64edb7
plugin_tutorial: use dedent=0
2023-05-11 08:08:52 -07:00
a88f291096
plugin_tutorial: fill in note about irc in plugin constructor
2023-05-11 08:08:52 -07:00
94784eb88d
plugin_tutorial: wording tweaks
2023-05-11 08:08:52 -07:00
5e63c271b6
plugin_tutorial: revise / condense test.py section and conclusion
2023-05-11 08:08:52 -07:00
14ffe24e7a
plugin_tutorial: link directly to supybot.ircmsgs.IrcMsg
...
Co-authored-by: Val Lorentz <progval+git@progval.net>
2023-05-11 08:08:52 -07:00
54f94be56d
plugin_tutorial: rewrite / condense plugin.py section
...
- Add additional inline links to related doc pages
- Mention additional common uses of irc.reply and irc.error
2023-05-11 08:08:52 -07:00
fa43baf9a8
advanced_plugin_config: move configure (supybot-wizard) part further down
...
For 3rd party plugins this is so seldomly used it doesn't need to be front and center. Let's have the more important bits further up.
2023-05-11 08:08:52 -07:00
6e59457c5b
plugin_tutorial: rewrite and condense __init__ and config.py sections
2023-05-11 08:08:52 -07:00
d8bd095127
plugin_tutorial: rewrite and condense up to first half of __init__.py
...
- Suggest running supybot-plugin-create in a separate folder, as it helps with organization
- Update supybot-plugin-create example: it now asks more questions and fills in a lot of the doc fields for you
2023-05-11 08:08:52 -07:00
c4f477a4d4
develop/style: fix indent error
2023-04-30 11:56:21 -07:00
c6b501897e
Reword feature support notes about Supybot and Gribble
...
Neither of those are active anymore, so we shouldn't expect them to ever merge the new code really.
2023-04-30 11:45:25 -07:00
abf93c3180
plugin_tutorial: Supybot/Limnoria -> Limnoria
2023-04-30 11:45:25 -07:00
8e0582c325
develop: use new super() syntax to call parent constructors
2023-04-30 11:45:25 -07:00
b775986c38
style: copyedit, remove clauses that duplicate PEP8
2023-04-29 11:07:29 -07: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
29b3b2ed09
develop/httpserver: modernize import and super() calls
2022-07-26 08:16:24 +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
93cb169e8c
architecture: Fix references
2022-04-24 10:57:58 +02:00
de2f671229
architecture: Fix typos
2022-04-24 10:49:43 +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
7a41dc185d
irclib: Fix typo in the introduction of ChannelState
2022-03-08 22:44:30 +01:00
6e203b9f78
plugin_distribution: Remove warning about the pip method being experimental
2022-02-05 16:51:54 +01:00
d29257f1d9
plugin_distribution: Recommend installing from git repos first, it's easier than PyPI
2022-02-05 16:51:54 +01:00
