Skip to content

[Docs] Add examples for hooks.json and a comprehensive overview of agent hooks/keys #1466

@flanny7

Description

@flanny7

Thank you for developing and maintaining Rulesync. It’s a fantastic tool and I really appreciate the help it provides!

I am writing to suggest a few improvements to the documentation:

1. Missing Examples in hooks.json
Currently, there is no "Example" section in the hooks.json entry within the documentation.
(Reference: https://rulesync.dyoshikawa.com/reference/file-formats.html#rulesync-hooks-json)
Adding a concrete usage example would be very helpful.

2. Comprehensive Overview of Agent Hooks & Keys
Since the "available hooks" and "available keys" vary significantly between different AI agents, it would be extremely useful to have a comprehensive overview or a comparison matrix documenting these differences.

Why this helps:
Making the usage and agent-specific differences explicit would make it much easier to recommend Rulesync to other developers. Furthermore, because AI tools update frequently, having a clear baseline of Rulesync's current capabilities versus the status of each AI tool would help the community understand the differences and raise more accurate issues when updates occur.

I would greatly appreciate it if you could enhance the documentation to include these details and keep it updated alongside future changes. Thank you for your time!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions