Conversation
jonandersen
force-pushed
the
jonandersen/update-readme
branch
from
574e6fe to
125c2f9
Compare
| ```bash | ||
| ai-rules init | ||
| ``` | ||
| This creates an `ai-rules/` directory with an example rule file. The command uses a built-in [Goose recipe](https://block.github.io/goose/docs/guides/recipes/) to generate a context-aware rule file automatically. If Goose is not available, it falls back to creating a basic example template. |
Collaborator
There was a problem hiding this comment.
It is good to have a short "quick start". However, if I am new users, from step 1 and step 2, come people might get confused with the example rule file, like what it does, what is actually used for. Maybe we can leave this part or replace with some short explanation here and later on we can enhance our tool experience via code? WDYT?
| 2. **Add/Edit your rules** in `ai-rules/example.md` or create your own rule files | ||
| 2. **Add your rules** in `ai-rules/*.md` files | ||
|
|
||
| 3. **Configure for rule generation**(Optional) in `ai-rules/ai-rules-config.yaml` (see [Configuration](#configuration)) |
Collaborator
There was a problem hiding this comment.
maybe we could leave here? I found this is useful to let people know at earlier stage, especially the agents
lifeizhou-ap
approved these changes
Jan 26, 2026
Collaborator
lifeizhou-ap
left a comment
lifeizhou-ap
left a comment
There was a problem hiding this comment.
Thank you so much! I was thinking about this last year too as our README gets longer :)
jonandersen
force-pushed
the
jonandersen/update-readme
branch
from
12b6211 to
91d47e2
Compare
Signed-off-by: Jon Andersen <jon.andersen.se@gmail.com>
- Add explanation of what rule files are for new users - Show --agents flag earlier in Quick Start to highlight selective generation Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: Jon Andersen <jon.andersen.se@gmail.com>
jonandersen
force-pushed
the
jonandersen/update-readme
branch
from
91d47e2 to
2fad90b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.