()
| 2 | import React from "react"; |
| 3 | |
| 4 | export default function HowToUseSection() { |
| 5 | const steps = [ |
| 6 | { |
| 7 | title: "Add AGENTS.md", |
| 8 | body: ( |
| 9 | <> |
| 10 | Create an AGENTS.md file at the root of the repository. Most |
| 11 | coding agents can even scaffold one for you if you ask nicely. |
| 12 | </> |
| 13 | ), |
| 14 | }, |
| 15 | { |
| 16 | title: "Cover what matters", |
| 17 | body: ( |
| 18 | <> |
| 19 | <p className="mb-2">Add sections that help an agent work effectively with your project. Popular choices:</p> |
| 20 | <ul className="list-disc list-inside ml-4 space-y-1"> |
| 21 | <li>Project overview</li> |
| 22 | <li>Build and test commands</li> |
| 23 | <li>Code style guidelines</li> |
| 24 | <li>Testing instructions</li> |
| 25 | <li>Security considerations</li> |
| 26 | </ul> |
| 27 | </> |
| 28 | ), |
| 29 | }, |
| 30 | { |
| 31 | title: "Add extra instructions", |
| 32 | body: "Commit messages or pull request guidelines, security gotchas, large datasets, deployment steps: anything you’d tell a new teammate belongs here too.", |
| 33 | }, |
| 34 | { |
| 35 | title: "Large monorepo? Use nested AGENTS.md files for subprojects", |
| 36 | body: ( |
| 37 | <> |
| 38 | Place another AGENTS.md inside each package. Agents automatically read the nearest file in the directory tree, so the closest one takes precedence and every subproject can ship tailored instructions. For example, at time of writing the main OpenAI repo has 88 AGENTS.md files. |
| 39 | </> |
| 40 | ), |
| 41 | }, |
| 42 | ]; |
| 43 | |
| 44 | |
| 45 | return ( |
| 46 | <Section |
| 47 | title="How to use AGENTS.md?" |
| 48 | className="py-12" |
| 49 | center |
| 50 | maxWidthClass="max-w-3xl" |
| 51 | > |
| 52 | <div className="space-y-6 text-left"> |
| 53 | {steps.map((s, idx) => ( |
| 54 | <div key={idx}> |
| 55 | <h3 className="text-xl font-semibold text-gray-900 dark:text-white mb-2"> |
| 56 | {idx + 1}. {s.title} |
| 57 | </h3> |
| 58 | <div className="text-gray-700 dark:text-gray-300"> |
| 59 | {s.body} |
| 60 | </div> |
| 61 | </div> |
nothing calls this directly
no outgoing calls
no test coverage detected