Skip to content
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This is a **template repository** for a web-based catalog of an organization's p

**Do not restructure the codebase.** This project is intentionally designed as a template where the only expected user customization is editing `public/config.yaml` and `public/tag-groups.js` at instantiation — and occasionally updating `ADDITIONAL_REPOS` or `ADDITIONAL_HF_REPOS` when non-org repos must be added.

The `public/config.yaml` file is intended to be stable and reusable across repositories utilizing this template; new functionality should not require changes to existing configuration settings. The `public/tag-groups.js` file is likely to be unique to each template user and should have tag groups added as needed (proper use is described in `docs/tag-grouping-process.md`); **do not delete tag groups**.
The `public/config.yaml` file is intended to be stable and reusable across repositories utilizing this template; new functionality should not require changes to existing configuration settings. The `public/tag-groups.js` file is likely to be unique to each template user and should have tag groups added as needed (proper use is described in `docs/tag-grouping-process.md`). A tag group should only combine tags with the **same meaning** (alternate spellings, hyphen/space variants, singular/plural forms, abbreviations); do not create broader topic or category groups.

Source files (`src/`) and scripts (`scripts/`) can be updated as needed for new functionality as long as changes adhere to the templated design principles established here.

Expand Down
6 changes: 3 additions & 3 deletions docs/tag-grouping-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ side-by-side. Pay particular attention to:
- Singular/plural variants (`specimen` / `specimens`, `annotation` / `annotations`)
- Hyphenated vs. space-separated forms (`animal-behavior` / `animal behavior`)
- Acronyms and their expansions (`cv` / `computer vision`, `xai` / `explainable ai`)
- Closely related concepts that warrant separate canonical tags vs. one broader group
- Related but distinct concepts (e.g., `phylogenetics` / `phylogeny`, `bioclip` / `bioclip2`) stay separate - groups only combine tags with the same meaning, not broader topics or categories
- Any domain-specific or specialized terms. In our case, this was the Hawaiian birds and plants that Claude did not recognize.

The manual pass by those familiar with the terms provides the most value, but is facilitated by the initial grouping.
Expand Down Expand Up @@ -93,8 +93,8 @@ You should update `public/tag-groups.js` when that PR is opened or updated.

| Situation | Action |
|-----------|--------|
| It's a variant of an existing concept (e.g. `bird-detection` when `object detection` exists) | Add the raw tag to the existing group's array |
| It represents a new concept that groups with other existing or new tags | Add a new key + array, under the appropriate section comment |
| It has the same meaning as an existing group (e.g. `camera-trap` when `camera traps` exists, or `vlms` when `vision-language models` exists) | Add the raw tag to the existing group's array |
| It has the same meaning as other existing or new tags not yet in a group | Add a new key + array, under the appropriate section comment |
| It's a Hugging Face system tag (contains a colon, e.g. `license:mit`) | No edit - these are filtered out by the app and will not reach the UI (see [above](#what-are-tag-groups) for how to not filter these out) |
| It's a one-off with no grouping candidates | No edit - it passes through unchanged and appears as-is in the UI |

Expand Down
Loading
Loading