Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Update the doc of the IRC bridge integration.#870

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
Niloth-p wants to merge1 commit intozulip:main
base:main
Choose a base branch
Loading
fromNiloth-p:docs/irc

Conversation

Niloth-p
Copy link
Contributor

@Niloth-pNiloth-p commentedJun 5, 2025•
edited
Loading

Screenshots

IRC doc link
image
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 (seecommit 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.

Copy link

@laurynmmlaurynmm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

@Niloth-p - Thanks for working on updating this doc! Overall, these updates look good. I had a few thoughts on revisions/tweaks that could make the instructions clearer. Let me know if you have any questions!

Niloth-p reacted with rocket emoji
@Niloth-p
Copy link
ContributorAuthor

Thank you for the review! Updated as recommended.
I've also switched to using backticks instead of double quotes for channel and topic names, and added the prefix# in front of channel names (because that's the convention in the Help docs -example), based on your review comment on another doc PR.

Screenshots

image
image

Comment on lines 19 to 20
1. [Subscribe the bot][subscribe-channels] to the Zulip channel that will
contain the mirror.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change
1.[Subscribe the bot][subscribe-channels] to the Zulip channel that will
contain the mirror.
1.[Subscribe the bot][subscribe-channels] to the Zulip channel where IRC messages should be mirrored.

Niloth-p reacted with thumbs up emoji
@alya
Copy link
Contributor

alya commentedJul 1, 2025

Is this 1-way mirroring or 2-way mirroring? Everything in the doc sounded like 1-way mirroring until I got to the screenshots.

Niloth-p reacted with laugh emoji

@Niloth-p
Copy link
ContributorAuthor

Niloth-p commentedJul 2, 2025•
edited
Loading

Thank you for the review!
I totally missed accounting for the 2-way mirroring.

Updates:

  • Suggested re-phrasing.
  • Bold formatting for channel names (including the IRC channel name).
  • Double quotes for topic names.
  • 2-way mirroring related updates: The intro line, the instruction regarding the integration script command.
  • Added a new instruction at the end.

Screenshots

image
image

@alya
Copy link
Contributor

alya commentedJul 2, 2025

Why is it<zuliptestbot[m]>, by the way, as opposed to<zulip> perhaps?

@alya
Copy link
Contributor

alya commentedJul 2, 2025

Passing on to@timabbott for review.

Niloth-p reacted with hooray emoji

@Niloth-p
Copy link
ContributorAuthor

Why is it <zuliptestbot[m]>, by the way, as opposed to perhaps?

That screenshot is pretty old. It's probably just a random bot name, I'm not sure. I would have expected the bot's nick to end with "_zulip" too, to avoid echoing. We'll need to update the IRC screenshot in sync with the Zulip screenshot, which we would update once we have support for generating screenshots of message threads. So, the image updates would go in a separate update later.

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@alyaalyaalya left review comments

@laurynmmlaurynmmlaurynmm left review comments

Assignees
No one assigned
Labels
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

4 participants
@Niloth-p@alya@laurynmm@zulipbot
[8]ページ先頭
©2009-2025 Movatter.jp