What is the way I should think about AGENT.md’s upgradability?

Phoenix Forum Questions / Help
1

What is the way I should think about AGENT.md’s upgradability. Should I assume it will always be updated with each Phoenix or LiveView update or should it be treated as a separate package and I should periodically check for an upgraded version? Thx @josevalim @chrismccord

1 Like
2

It is set up to use usage_rules v0.1.23 — Documentation out of the box.

So you can use mix usage_rules.sync phoenix:all after upgrading Phoenix to replace the “fenced” usage rule sections with their updated versions. If you edit those sections by hand, you’ll lose those edits, so I suggest editing outside of those commented sections.

5 Likes
3

usage_rules or copy paste. Remember this file can ultimate serve as a basis for your own guidelines so it’s not necessarily just lock step with our rules.

4

Got it. Thanks both.

But what is your thinking about it. Are you doing some tests/evals on what should or not be part of the default file? I saw some benchmarks on LLM performance with and without AGENT.md. Does it mean it’s a news category of development for you meaning you will always be tweaking and fine tuning the file or you already got a set of rules and the only change will come if a new feature is added or removed. Thanks

5

As (I believe) the fetching process works by grabbing the copy of the rules found in your downloaded deps, you can treat usage rules as part of a release artifact, meaning that even if it is tweaked and fine-tuned constantly you would only get those tweaks when a new version was released, or by having your deps track the main branch of a source repository and running mix deps.update for them—like any other source file in a package!

1 Like
6

Thanks, but I was referring specifically to Phoenix’s AGENT.md

I imagine the situation where it’s still the version 1.8.0 but the Phoenix creators did more test and found out that a different AGENT.md file with different set of instructions or notes produces a better result when coding with Sonnet/GPT*. The question is will they be updating the AGENT.md even though it’s still Phoenix 1.8.0 or it will become a 1.8.1 and that’s the flag for me to update?

7

There is no way to update 1.8.0 in place on hex.pm. A change will require a new version. You could follow the github repo to stay closer to up-to-date manually, but generally a release is required to publish changes.