Free for open source projects and schools. AI Council costs nothing for OSS maintainers and educational institutions. Apply →

Home / Docs / Conventions and knowledge

Conventions and knowledge

Conventions (team rules) and knowledge entries are what the agent learns about the project. A convention is delivered to the agent when it works with code bound to that convention. Review checks changes against the same conventions.

Creating a convention

Conventions screen → + Create.

FieldWhat to enter
NameA short name for the convention
DescriptionThe convention text. The agent receives it in full, so it has to be applicable without further explanation
Severitymust is mandatory, should is recommended, note is a note
CategoryThe area it covers: code, architecture and others
ScopeEntity for specific entities, Project for the whole project, Path for a location in the file tree
AudienceWho it is for. A review convention is checked during review and isn't delivered to the agent writing code
Binding conditionsBinding conditions in JSON, for example a path match

A convention with no bindings isn't delivered

If a convention has zero bindings, the agent won't receive it. Check the binding count on its card. After renaming or moving code, click Rebind.

Knowledge entries

Knowledge screen: decisions (decision), notes (note), changelogs (changelog), diagrams (diagram) and procedures (procedure). Entries are created by people and agents. An entry is delivered to the agent when it works with linked code. If the card shows zero linked entities, the entry isn't delivered: specify the files and modules it relates to.

Entries live on git branches. The branch picker in the header shows that branch's entries; the count for other branches is shown separately.

Freshness review

Knowledge review screen. Review doesn't change or hide an entry. It adds a label: "stale since commit…", "superseded by another entry" or "disputed". Readers get the entry together with its label.

  • Journal: applied decisions. Undo removes the label.
  • Proposals: verdicts the second opinion didn't confirm. A person applies them with the Apply button.
  • Marks: labels in effect for the selected branch.

The review model, daily limit and second opinion are configured in Settings → Knowledge review.

Next: Change review

Made on
Tilda