agentleFS
icantcodefyiicantcodefyi/sakuralang/website/AGENTS.md

sakuralang / website

AGENTS.md4 starsChanged 24 days agoApache-2.0View on GitHub

This version has breaking changes — APIs, conventions, and file structure may all differ from your training data. Read the relevant guide in node_modules/next/dist/docs/ (resolved from this file's directory; in monorepos the next package may not be visible from the repo root) before writing any code. Heed deprecation notices. This block is written and re-added by next dev — verify at node_modules/next/dist/server/lib/generate-agent-files.js. Removing it from a diff only re-creates the uncommitted change; committing it with your work keeps the tree…

  • 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 repository7 other files it gives its agents.

The file

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

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    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
  1. Very specific:

    Every displayed version comes from RELEASE in lib/release.ts: the hero badge, install commands, the status section, footer, changelog page …

    line 16

≈ “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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md
<!-- BEGIN:nextjs-agent-rules -->

This is NOT the Next.js you know

This version has breaking changes — APIs, conventions, and file structure may all differ from your training data. Read the relevant guide in node_modules/next/dist/docs/ (resolved from this file's directory; in monorepos the next package may not be visible from the repo root) before writing any code. Heed deprecation notices.

This block is written and re-added by next dev — verify at node_modules/next/dist/server/lib/generate-agent-files.js. Removing it from a diff only re-creates the uncommitted change; committing it with your work keeps the tree clean.

<!-- END:nextjs-agent-rules -->

Landing page

The page answers, in order: what Sakura Lang is, why use it, how it works with a coding agent, what the code looks like, whether it is fast, whether it is ready and how to start. Detail belongs in the docs, linked from there. Every displayed version comes from RELEASE in lib/release.ts: the hero badge, install commands, the status section, footer, changelog page and llms.txt. Change it only once the tag is published; then check that status.tsx still matches /docs/stability. /changelog renders the repository CHANGELOG.md, and vercel.json redeploys when it changes. Its Sakura samples live in components/landing/samples/*.sak and are checked by scripts/check-doc-sweep.py; the outputs shown beside them (code.tsx, install.tsx, tests-figure.tsx) are recorded from the compiler and must be re-recorded when they change. Benchmark figures come only from lib/bench.ts.

The hero tree is grown from a fixed seed in lib/sakura-tree.ts. app/tree-*.svg serve it as a poster per theme; tree-scene.ts (three.js, loaded by dynamic import only) draws the same tree live through the same camera. Keep three.js out of every static import. The figures loop in CSS (globals.css, Landing), only inside play.tsx and only without reduced motion.

Playground

/play (components/play/) compiles in the browser with public/play/sakura_playground.wasm, built from compiler/crates/sakura_playground by scripts/playground-wasm.sh and committed with its .sha256 (Vercel has no Rust); bun run build runs scripts/check-playground.mjs on it. Rebuild and commit it when a compiler change should reach the playground. Programs run in public/play/sandbox.html (opaque-origin iframe, no network), whose worker is the browser host. The wasm, the worker and Shiki's client highlighter load only on /play; keep them there.

CI coverage

Website changes select the website build, documentation examples and Tree-sitter corpus checks. The documentation job builds the current CLI and checks guide fences and landing samples. Keep sample changes alongside the copy that displays them; see the CI policy for focused manual verification.

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.