Skip to content

baremetrics: Fix doc.md to match current bot documentation standards.#911

Closed
hanyucrocks wants to merge 1 commit intozulip:mainfrom
hanyucrocks:fix-baremetrics-doc
Closed

baremetrics: Fix doc.md to match current bot documentation standards.#911
hanyucrocks wants to merge 1 commit intozulip:mainfrom
hanyucrocks:fix-baremetrics-doc

Conversation

@hanyucrocks
Copy link
Copy Markdown
Collaborator

@hanyucrocks hanyucrocks commented Mar 29, 2026

Fixes: #910

The doc.md for the Baremetrics bot had several issues compared to
the style used by other bots (xkcd, GIPHY):

  • Remove the ## Developer Notes section, which is internal contributor
    guidance, not user-facing documentation.
  • Fix a duplicate-word typo (short short descriptions).
  • Reformat the Usage entry to use the inline example style.
  • Add the standard "Run this bot" link after the Setup steps.

Screenshot of the revised version:
image

Self-review checklist
  • Self-reviewed the changes for clarity and maintainability
    (variable names, code reuse, readability, etc.).

Communicate decisions, questions, and potential concerns.

  • Explains differences from previous plans (e.g., issue description).
  • Highlights technical choices and bugs encountered.
  • Calls out remaining decisions and concerns.
  • Automated tests verify logic where appropriate.

Individual commits are ready for review (see commit discipline).

  • Each commit is a coherent idea.
  • Commit message(s) explain reasoning and motivation for changes.

Completed manual review and testing of the following:

  • Visual appearance of the changes.
  • Responsiveness and internationalization.
  • Strings and tooltips.
  • End-to-end functionality of buttons, interactions and flows.
  • Corner cases, error conditions, and easily imagined bugs.

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 zulip#910.
@hanyucrocks
Copy link
Copy Markdown
Collaborator Author

I believe the CI failing is a flaky issue. Tagging @timabbott for your insights.

@zulipbot zulipbot added the maintainer review PR is ready for review by Zulip maintainers. label Mar 30, 2026
@hanyucrocks
Copy link
Copy Markdown
Collaborator Author

@laurynmm are you open to reviewing this?

@laurynmm
Copy link
Copy Markdown

@hanyucrocks - Thanks for your interest in updating this integration's documentation!

I recommend checking out some of @Niloth-p's open and closed pull requests in this repository for documentation updates for the current style and structure for our integration documentation pages: https://github.com/zulip/python-zulip-api/pulls?q=is%3Apr+author%3ANiloth-p+doc.

@hanyucrocks
Copy link
Copy Markdown
Collaborator Author

Drafting this as of now, considering this will take time later on.

@hanyucrocks hanyucrocks marked this pull request as draft March 31, 2026 17:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintainer review PR is ready for review by Zulip maintainers.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

baremetrics: Update documentation for current style/structure of integration docs.

3 participants