Orbit documentation: docs, wiki and FAQ pages
This commit is contained in:
commit
bcbe5fff22
18 changed files with 714 additions and 0 deletions
31
wiki/orbit-channel.md
Normal file
31
wiki/orbit-channel.md
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
# The #orbit channel & bot
|
||||
|
||||
**#orbit** is the project's live IRC channel. A bot named **`Pulsar`** stays connected there and does
|
||||
two things.
|
||||
|
||||
## Commit announcements
|
||||
|
||||
Every push to the project's git server, Pulsar posts a GitHub-style summary to #orbit, with mIRC colours:
|
||||
|
||||
```
|
||||
[orbit] alice pushed 2 commits to main [+0/-0/±2] https://…/compare/abc…def
|
||||
[orbit] alice 1a2b3c4 - Fix a thing
|
||||
[orbit] alice 5d6e7f8 - Add another thing
|
||||
```
|
||||
|
||||
## Interactive commands
|
||||
|
||||
Talk to the bot in-channel or by PM (the `!` prefix):
|
||||
|
||||
| Command | Reply |
|
||||
|---------|-------|
|
||||
| `!help` | List of commands. |
|
||||
| `!about` | What Orbit is + link. |
|
||||
| `!commits [n]` | The latest commits, live from the repo. |
|
||||
| `!stats` / `!version` | Repo stats / current version. |
|
||||
| `!source` / `!app` | Repo and live-client links. |
|
||||
| `!account <nick>` | Whether a nick is a registered account. |
|
||||
| `!uptime` / `!ping` | Bot status. |
|
||||
|
||||
The bot is a Django management command, so `!account` reads the real account database. Join it from
|
||||
the client: [open #orbit](https://tchatou.fr/app/?channel=%23orbit).
|
||||
Loading…
Add table
Add a link
Reference in a new issue