Skip to content

Add AGENTS.md#99

Open
Copilot wants to merge 7 commits into
mainfrom
copilot/add-agents-file
Open

Add AGENTS.md#99
Copilot wants to merge 7 commits into
mainfrom
copilot/add-agents-file

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 14, 2026

Agents working on this repo have missed key functional details and have a tendency to over-restructure code. AGENTS.md captures the patterns and constraints that matter most.

What's documented

  • Templated design constraint — customization is config.yaml-only; code structure should not be restructured beyond what a specific fix requires
  • Hugging Face API specifics
    • List vs. detail URL patterns for datasets, models, spaces
    • Model browser-link format: huggingface.co/{owner}/{repo} (no /models/ prefix)
    • cardData is not returned by the bulk models list — each model requires a secondary per-model fetch to get model_name, model_description, tags, etc.
    • cardData key shape differs by resource type (pretty_name / model_name / title)
  • Testing scope — tests validate utility logic in src/; they only need to run on code changes, not on site operation
  • Quick reference — repo layout, config fields, build/dev commands, CI workflows

Copilot AI linked an issue May 14, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Add AGENTS.md file to summarize key functionalities Add AGENTS.md May 14, 2026
Copilot AI requested a review from egrace479 May 14, 2026 21:34
Comment thread AGENTS.md Outdated
@egrace479 egrace479 requested a review from EmersonFras May 14, 2026 21:49
Copy link
Copy Markdown
Contributor

@EmersonFras EmersonFras left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, left one note about the hardcoded Node version and response to the suggested change but everything else I think is well structured.

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
@egrace479 egrace479 marked this pull request as ready for review May 15, 2026 22:13
@egrace479
Copy link
Copy Markdown
Member

Looks good, left one note about the hardcoded Node version and response to the suggested change but everything else I think is well structured.

@EmersonFras, I don't see a response at the suggested change.

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md
Comment thread AGENTS.md Outdated
Clarify PR behavior for fixes

Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
Copy link
Copy Markdown
Member

@hlapp hlapp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See inline suggestions and comments.

Comment thread AGENTS.md

## Project Overview

This is a **template repository** for a web-based catalog of an organization's public code, datasets, models, and spaces. It fetches live data from the GitHub API and the Hugging Face API and renders a searchable, filterable catalog page as a static site via GitHub Pages. The default setup is for the Imageomics Organization's GitHub and Hugging Face products, and this Imageomics Catalog is live.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This is a **template repository** for a web-based catalog of an organization's public code, datasets, models, and spaces. It fetches live data from the GitHub API and the Hugging Face API and renders a searchable, filterable catalog page as a static site via GitHub Pages. The default setup is for the Imageomics Organization's GitHub and Hugging Face products, and this Imageomics Catalog is live.
This is a **template repository** for a web-based catalog of an organization's public code, datasets, models, and spaces. It fetches live data from the code repository platform (such as GitHub) API and the platform API for hosting datasets and models (Hugging Face) and renders a searchable, filterable catalog page as a static site via GitHub Pages. The default setup is for the Imageomics Organization's GitHub and Hugging Face products, and this Imageomics Catalog is live.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was the live or this Imageomics Catalog meant to be linked to the live site? Also, note that in a fork this wording won't work well. Maybe more like this: The default setup is for the Imageomics Organization's GitHub and Hugging Face products. (I.e., it's not clear what the reference to the live site would add to the coding agent's ability to work better.)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking it should know that it is in fact run off this repository, but perhaps leaving the default setup information is sufficient since the deploy workflow is described later.

Comment thread AGENTS.md Outdated
Co-authored-by: Hilmar Lapp <hlapp@drycafe.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add agents file

4 participants