phpbotscout¶

A support and moderation bot bridging Discord and GitLab. It answers questions from the published phpboyscout documentation and public source, citing what it used, and declines when the documentation does not answer.

What works today¶

• Answering at the command line. phpbotscout ask retrieves passages from the indexed corpus and composes a grounded, cited answer — or declines.
• Building and refreshing the corpus. phpbotscout index discovers every public, documented repository in the phpboyscout group and indexes it.
• Watching Discord, read-only. phpbotscout serve connects the gateway, reads allowlisted channels, and keeps the index current on a timer.

It cannot yet answer, post or moderate in Discord, and it cannot raise issues. See what phpbotscout does not do before planning around anything.

Start here¶

• Getting started — install it and run your first command.
• Answer your first question from the docs — the full path, from nothing to a cited answer, in about twenty minutes.

The documentation¶

Organised by the Diátaxis framework:

• Tutorials — learning-oriented lessons.
• How-to guides — task-oriented recipes, including diagnosing a bad answer.
• Reference — commands, configuration keys, indexing rules, and limitations.
• Explanation — how it works and why it was built this way.

If you are a Discord member wondering what the bot does with your messages, that is the policy page.

Further reading¶

Everything written about the estate, including the curated guides, is on the blog.