ObsidianUI
AGENTS.md526 starsChanged 39 days agoMITView on GitHub
Read ACEBUILDER.md for the user's saved shadcn, Aceternity, theme, accessibility, and motion conventions. Use the nine repository-local skills listed there from skills/, applying each within its stated scope. This checkout is ObsidianUI, a component library and documentation site. The user authorized the upgrade to Next.js 16.3.4, React 19, Tailwind CSS v4, and Nextra 4 with App Router. The Ara paths in the supplied reference remain template examples; this product is ObsidianUI. Keep standard shadcn primitives in src/components/ui, reusable custom components…
- Reads credentials
We split this AGENTS.md into the rules it gives an agent
2 rules. About 0 are common, 0 are distinctive, and 2 are 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.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 3
Read ACEBUILDER.md for the user's saved shadcn, Aceternity, theme, accessibility, and motion conventions.
- Very specific: line 9
Read existing code before editing, preserve the current brand, keep changes targeted, and verify with available checks.
≈ “Common” is an estimate: at least 1 in 5 of the 36,368 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
Project instructions
Read ACEBUILDER.md for the user's saved shadcn, Aceternity, theme, accessibility, and motion conventions. Use the nine repository-local skills listed there from skills/, applying each within its stated scope.
This checkout is ObsidianUI, a component library and documentation site. The user authorized the upgrade to Next.js 16.3.4, React 19, Tailwind CSS v4, and Nextra 4 with App Router. The Ara paths in the supplied reference remain template examples; this product is ObsidianUI.
Keep standard shadcn primitives in src/components/ui, reusable custom components in src/components/block, landing sections in src/components/landing, shared site chrome in src/components/site, media helpers in src/components/media, and route feature roots in src/components/pages. Docs content lives in src/content; route files in src/app stay thin. Tooling belongs in root scripts and regression tests in tests.
Read existing code before editing, preserve the current brand, keep changes targeted, and verify with available checks. Never claim unavailable platform tools ran. Do not run npx shadcn add; the user's installation convention is the platform registry tool. Never write .env* files or expose secrets.
PROJECT_REVIEW.md records the initial orientation and subsequent fixes. Recheck observations against current code. Run npm run check for lint, type checking, tests and production build. Regenerate public/r from source using npm run registry:build; never hand-edit generated manifests.
<!-- 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 -->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 28,693 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 repository11 other files it gives its agents.
- public/llms-full.txtllms.txt
- public/llms.txtllms.txt
- better-accessibilitySkill
- better-colorsSkill
- better-interfaceSkill
- better-layoutSkill
- better-typographySkill
- better-uiSkill
- better-writingSkill
- interface-reviewSkill
- transitions-devSkill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
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.