algal / site
AGENTS.md20 starsChanged 41 days agoMITArchived repositoryView on GitHub
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 32,671 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 repository3 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- site/llms.txtllms.txt
The file
We split this AGENTS.md into the rules it gives an agent
2 rules. About 0 are common, 1 is distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 17
Keep Design Kit and UI as pinned build-only dependencies.
- Very specific: line 21
Run the repository's bun run check and inspect the built header at phone and desktop sizes before delivery.
≈ “Common” is an estimate: at least 1 in 5 of the 41,581 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.
Files
Contents
chrome.ts,pages/,styles.css, andbuild.tsown the static ALGAL website and its executable example projections.pages/holds the home, tour, use-cases, living, and workbench fragments composed intochrome.ts's shared shell.copy.tsholds text rendered in more than one place: the home description (also the JSON-LD andllms.txtlead), the tagline (also the social card description), and the shared limits paragraphs.social-image.tsis the site's onedefineSocialImageSitedeclaration (name, domain, description, the header's foil markalgal-mark.svg, and thetokyo-nightpalette the header uses).build.tsrenders/og.pngand one/og/blog/<slug>.pngper post from it.markdown.tsis the dependency-free renderer behind the/docs/mirror:build.tsrenders the curateddocs/set and all ofspec/v1/into/docs/and/docs/spec/with one shared navigation rail. Repository markdown stays the source of truth; internal working notes are deliberately unmirrored and their links resolve to the GitHub blob.highlight.tsis the dependency-free tokenizer for the languages the shared@hraness/design-kit/syntax-highlightinglayer does not know:highlightAlgalforalgalfences and executable examples,highlightJsonfor the browser program and evidence viewers. Keep the algal grammar aligned with thesrc/source.tslexer and never let a highlighter throw on a fragment. Keep it dependency-free so browser bundles do not pull in sugar-high.viewer.tsis the browser-side interactive diagram runtime: pan/zoom, cell inspection, and recorded-run replay driven byalgal.diagram-view.v1documents emitted bybuild.ts. It shares layout geometry withsrc/diagram.ts'slayoutDiagramand degrades to the static SVG fallback without JavaScript.blog.tsrendersblog/*.mdwith the Design Kit article layer and writes the blog index, Atom feed, sitemap entries, and llms.txt list;blog-posts.tsholds each post's review record (ArticleAdmission), its sources, and cross-host links waiting to go live. Onlyindexableposts reach the index, sitemap, feed, and llms.txt;quarantinedposts render with robots noindex.icons.tsholds the Hugeicons sprite map; icon references are root-relative/icons.svg#name.algal-mark.svg,BRAND_ASSETS.md,client.ts, andappearance.tsbind the existing product identity to the released metallic treatment.
Guidelines
- Preserve executable examples, navigation, the
{{PLACEHOLDER}}tokens inpages/, and the Tokyo Night palette and light/dark/system appearance. A design change does not rewrite product copy as a side effect. - Copy edits follow the root
AGENTS.md"Public copy" section andSTYLE.md. Verify each command, flag, and limit against the CLI and docs before you change it, keep every true limit, and put text shown on more than one page incopy.ts. The site tagline and home H1 come from the portfolio messaging record (productalgal). - Keep Design Kit and UI as pinned build-only dependencies; the CLI retains zero required runtime dependencies.
- Bundle the released marketing stylesheet with its syntax stylesheet and license. Do not fork its foil recipe.
- Share images come only from the shared
@hraness/web-discoverysocial-image template via the singledefineSocialImageSitedeclaration insocial-image.ts. Pages pass copy only (headline, description, eyebrow); add no per-site drawing code, custom card layouts, or committed card PNGs. - The header mark and wordmark share the released recipe. Retain the original image underneath the alpha mask for forced colors and unsupported masks.
- Run the repository's
bun run checkand inspect the built header at phone and desktop sizes before delivery. Preserve required remote checks and exact production identity verification. - Website names, product descriptions, hero copy, and named headings read the website-local
portfolio-messaging.generated.jsonprojection ofhttps://hraness.com/portfolio.json. Edit the canonical Jungle portfolio registry and refresh that snapshot; ordinary builds never fetch or rewrite it.
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
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.

