From e2b7ac9865a864ff88cef689d1b38c16c0d3bf43 Mon Sep 17 00:00:00 2001 From: Agnish Bauri Date: Sun, 29 Mar 2026 12:56:21 +0530 Subject: [PATCH] baremetrics: Fix doc.md to match current bot documentation standards. Remove the Developer Notes section, which is internal contributor guidance rather than user-facing documentation. Fix a duplicate-word typo in the Usage section, reformat the Usage entry to match the inline example style used by other bots (xkcd, GIPHY), and add the standard "Run this bot" link after the Setup steps. Fixes #910. --- zulip_bots/zulip_bots/bots/baremetrics/doc.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/zulip_bots/zulip_bots/bots/baremetrics/doc.md b/zulip_bots/zulip_bots/bots/baremetrics/doc.md index 720ca3bc2..21a323e89 100644 --- a/zulip_bots/zulip_bots/bots/baremetrics/doc.md +++ b/zulip_bots/zulip_bots/bots/baremetrics/doc.md @@ -20,11 +20,7 @@ To do this, follow the given steps: 3. Open up `zulip_bots/bots/baremetrics/baremetrics.conf` in an editor and change the value of the `` attribute to the noted `Live API Key`. -## Developer Notes - -Be sure to add the command and its description to their respective lists (named `commands` and `descriptions`) -so that it can be displayed with the other available commands using `@ list-commands`. Also modify -the `test_list_commands_command` in `test_baremetrics.py`. +Run this bot as described in [here](https://zulip.com/api/running-bots#running-a-bot). ## Links @@ -35,7 +31,5 @@ the `test_list_commands_command` in `test_baremetrics.py`. ## Usage `@Baremetrics list-commands` - This command gives a list of all available commands along with short -short descriptions. - -Example: +descriptions. Example usage: `@Baremetrics list-commands`: ![](assets/list-commands.png)