agentleFS
AntiQualityAntiQuality/masthead-project-page-template/AGENTS.md

masthead-project-page-template

AGENTS.md7 starsChanged 19 days agoMITView on GitHub

Instructions for AI coding agents working on a Masthead project page. Read this before editing. A static project page for one research paper. Plain HTML, CSS and JavaScript with no build step and no dependencies. GitHub Pages serves index.html from the repo root. Ask the user for the PDF or LaTeX source, the BibTeX, the final author list with links, the venue and the figures. Then work top to bottom through index.html: Never invent results, numbers, authors, venues or links.…

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,439 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository2 other files it gives its agents.

The file

Show its rules and text

We split this AGENTS.md into the rules it gives an agent

16 rules. About 0 are common, 10 are distinctive, and 6 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈10

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Ask the user for the PDF or LaTeX source, the BibTeX, the final author list with links, the venue and the figures.

    line 23
  2. Very specific:

    Sections: Keep the modules the paper has material for and delete the rest.

    line 30
  3. Distinctive:

    Never invent results, numbers, authors, venues or links.

    line 35
  4. Very specific:

    Results table: Put data-sort="num" or data-sort="text" on each sortable <th>.

    line 41
  5. Distinctive:

    Follow these rules in everything you write: visible copy, alt text, captions, HTML, CSS and JS comments, the README and text inside images.

    line 48
  6. Distinctive:

    No middle dots (·): Use a comma or a colon, or rephrase.

    line 51
  7. Distinctive:

    Ranges in words: Write "1 to 4", not "1–4".

    line 53
  8. Distinctive:

    Plain, specific sentences: Prefer the paper's own numbers and terms over adjectives.

    line 55
  9. Distinctive:

    Check before you finish:

    line 59
  10. Distinctive:

    No frameworks, build tools, package managers or CDN scripts.

    line 69
  11. Very specific:

    Every color comes from a variable in tokens.css, so dark mode keeps working.

    line 70
  12. Distinctive:

    Keep the page readable without JavaScript and keep the reduced motion handling.

    line 71
  13. Distinctive:

    Keep images reasonably small.

    line 72
  14. Very specific:

    Make sure no placeholder text is left: search for Project Name, Paper Title, your-username, First Author, example.com and 0000.00000.

    line 78
  15. Distinctive:

    Run the text style check above.

    line 79
  16. Very specific:

    If this repo has skills/masthead/scripts/check_page.py, run python3 skills/masthead/scripts/check_page.py index.html and fix what it …

    line 80

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

AGENTS.md

Instructions for AI coding agents working on a Masthead project page. Read this before editing.

What this repo is

A static project page for one research paper. Plain HTML, CSS and JavaScript with no build step and no dependencies. GitHub Pages serves index.html from the repo root.

Files

FileEdit it to
index.htmlWrite the page. Every block is marked with a MODULE comment.
assets/css/tokens.cssChange colors, fonts and page width, for light and dark mode.
assets/css/themes/*.cssOptional presets. Link one after tokens.css to use it.
assets/css/masthead.cssComponent styles. Leave it alone unless a layout truly needs a change.
assets/js/masthead.jsBehavior (theme toggle, sorting, reveals). Rarely needs edits.
assets/media/Figures, video, poster frame and social-preview.png.
assets/logo.svgLogo in the top bar, hero and favicon.

Filling the page from a paper

Ask the user for the PDF or LaTeX source, the BibTeX, the final author list with links, the venue and the figures. Then work top to bottom through index.html:

  1. Meta block. Replace every placeholder in <head>: title, description, canonical URL, Open Graph and Twitter tags, citation_* tags and the JSON-LD block. One citation_author per author, written "Last, First". og:image and twitter:image must be absolute URLs to a 1200 by 630 PNG or JPG.
  2. Top bar. Project name, plus one nav link per section that stays on the page. Each link href must match a section id.
  3. Hero. Venue in the eyebrow, with the badge for Oral, Spotlight or similar (delete the badge otherwise). Title, with at most one word wrapped in <span class="hl">. A two or three sentence pitch. Resource buttons for Paper, Code, Data, Video and so on. Use <span class="btn soon"> for anything not released yet. Authors, affiliations and the equal contribution note.
  4. Abstract. A one-line hook in .lede, then the abstract in two or three short paragraphs.
  5. Stats strip. Three to six numbers from the paper. Keep each short (12K, not 12000). data-n is the final value and data-dec its decimal places. Mark the most important one with class key.
  6. Sections. Keep the modules the paper has material for and delete the rest. Renumber the .sn spans so they run 01, 02, 03 in order.
  7. Cite. Paste the BibTeX inside <pre> as is.
  8. Footer. Project name, institution, venue and links. Keep the Masthead credit line unless the user asks to remove it.
  9. Social preview. Make assets/media/social-preview.png (1200 by 630) show the paper title, or ask the user for one.

Never invent results, numbers, authors, venues or links. If the paper does not provide something a module needs, delete the module or ask the user.

Module notes

  • Figures. <figure class="fig"> with an <img class="frame">, real width and height attributes, loading="lazy" and descriptive alt text. Captions start with <b>Figure N.</b>.
  • Video. Self-hosted clips use <video ... data-autoplay loop muted playsinline>, which plays only while on screen. YouTube goes in the commented .embed block. The Video button in the hero links to #video, so keep that id on the video subheading.
  • Results table. Put data-sort="num" or data-sort="text" on each sortable <th>. Bold the best value per column with <b>. Use n/a for missing values and give that cell data-v="". A formatted cell like 5.2 h needs a raw data-v value so it sorts correctly.
  • Bar chart. Set --ymax on .plot, --v on each .bar and --i as a running index for the stagger. Series colors are classes s1 to s4. Keep the legend chips in the same order as the bars, and label each group in .xl.
  • Comparison cards. Two .card elements around a .delta. Add class hi to the card that should stand out. The delta text names the single change between the two.
  • Case study. One .lane per method with class good, warn or bad. Mark the step where a method went wrong with .ts.crit. In the outcome bar, the flex values are counts.

Text style

Follow these rules in everything you write: visible copy, alt text, captions, HTML, CSS and JS comments, the README and text inside images.

  • No em dashes or en dashes. Rewrite with a period, comma, colon or parentheses.
  • No middle dots (·). Use a comma or a colon, or rephrase.
  • No semicolons. Split into two sentences or join with "and", "but" or "while".
  • Ranges in words. Write "1 to 4", not "1–4".
  • Missing values are n/a.
  • Plain, specific sentences. Prefer the paper's own numbers and terms over adjectives.

Code syntax is exempt. Semicolons in JavaScript and CSS and en dashes inside URLs are fine.

Check before you finish:

grep -nE '—|–|·|&mdash;|&ndash;|&middot;' index.html README.md assets/css/*.css assets/js/*.js

Any hit in prose or comments needs a rewrite. Also read your new sentences for semicolons.

Constraints

  • No frameworks, build tools, package managers or CDN scripts. Google Fonts is the only external request.
  • Every color comes from a variable in tokens.css, so dark mode keeps working. Do not hardcode colors in index.html.
  • Keep the page readable without JavaScript and keep the reduced motion handling.
  • Keep images reasonably small. Compress PNG and JPG, and prefer SVG for diagrams.

Before you finish

  1. Serve the folder (python3 -m http.server) and open the page in light mode, dark mode and at phone width (about 375 px). Nothing should scroll sideways except tables and charts.
  2. Click every nav link, resource button and the BibTeX copy button.
  3. Make sure no placeholder text is left: search for Project Name, Paper Title, your-username, First Author, example.com and 0000.00000.
  4. Run the text style check above.
  5. If this repo has skills/masthead/scripts/check_page.py, run python3 skills/masthead/scripts/check_page.py index.html and fix what it reports.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.