- Remove redundant language. Focus on the key functions / classes and their inputs
- Add an example for registerNetworkValue()
- Describe the behaviour difference of private values
- Consistently use `plugins.WorldDom.attackTargets.air` in examples (previously it was inconsistent with `plugins.WorldDom.air`)
- Format types with :class:
- Remove fallback code for supybot / gribble. These are Py2-only and unlikely to be relevant these days
- Remove the discussion of README and copyright header. These are already very self documenting
- Add links to the `help` syntax reference in use/getting_started
- Update the headings to include the contents of each file in addition to its name for easier navigation
- Further remove redundant language
- Add concrete examples of contexts: optional and multiple arguments
- Add examples of converters that don't (always) read command line arguments, such as 'op' and 'channel'
- Switch examples to use the decorator syntax for "wrap". This is common among chatbots these days
- Make the motivating example more concise
- Make the text less repetitive
- Mention the reply.mores.instant option. This can be useful on quieter rooms and is a nice segue to the next page (Configuration)
- 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.
- 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
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
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.
- 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)
- 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
