Updated documentation for chat-members plugin, adding new sections about filters

[rayz1065]

This pull request adds documentation for chat member filters in the chat-members plugin section.

grammyjs/chat-members#10

Let me know if the paragraph structure or anything else could be improved.

[github-actions]

🚀 Deployed on https://67b5dae99f5f605d1e6a7d88--grammy.netlify.app

[KnorpelSenf]

Got a few things here and there, mostly nitpicks. Thanks for the extensive docs, though, we need more people like you who do this!

[KnorpelSenf]

LGTM

[KnorpelSenf]

@roziscoding anything else?

[roziscoding]

@roziscoding anything else?

not at all, this looks great!
thanks @rayz1065!

[KnorpelSenf]

LGTM.

If you want, you can add a few lines to the existing code example and contrast it with the code that is necessary without this plugin. This would be similar to how the explanations for the hydrate plugin work. This is just an idea, feel free to ignore it—I approve either way.

[rayz1065]

add a few lines to the existing code example and contrast it with the code

Were you thinking something like:

In contrast, filtering for users joining a group/supergroup without this plugin would require the following code:

// filter for users joining the group without the plugin
bot
  .chatType(["group", "supergroup"])
  .on("chat_member")
  .filter(
    (ctx) => {
      const { old_chat_member: oldMember, new_chat_member: newMember } =
        ctx.chatMember;
      return (
        (["kicked", "left"].includes(oldMember.status) ||
          (oldMember.status === "restricted" && !oldMember.is_member)) &&
        (["administrator", "creator", "member"].includes(newMember.status) ||
          (newMember.status === "restricted" && newMember.is_member))
      );
    },
    (ctx) => {
      ctx.chatMember.new_chat_member.status; // type is not narrowed :(
    }
  );

Right after the code-group showing the various filters?

[KnorpelSenf]

Yes, except that I would include it in the existing code group and add comments

// WITHOUT this plugin:
complexCode
// WITH this plugin:
easyCode

but that's just something to try out, I am not saying that I'm sure it's better

[rayz1065]

Yes, except that I would include it in the existing code group and add comments

I included that snippet within the code group, I think it's a nice addition as it makes for some nice contrast, let me know if it should be changed in some way.

Thank you @rojvv for the review!

Is there anything else that should be changed before this PQ is ready for translation?

[KnorpelSenf]

Looks great! Just two minor details

[KnorpelSenf]

top notch