Merge pull request #150 from OpenZeppelin/introduce-llms-txt

feat: Introduce llms.txt file and script for creating it

Author: zeljkoX

README.md

@@ -114,6 +114,14 @@ In the case you want to setup an automated GitHub workflow to create these API d
 3. Follow existing directory structure for consistency
 4. Update navigation if adding new product categories
 
+### Updating `llms.txt`
+
+The `public/llms.txt` file is generated from the navigation tree and MDX frontmatter. Run the generator whenever you add, remove, rename, or reorder navigation items, or when you update page descriptions that should appear in `llms.txt`.
+
+```bash
+pnpm run generate:llms-txt
+```
+
 ### Versioning
 
 - Version-specific content in numbered subdirectories (e.g., `contracts/4.x/`)

package.json

@@ -14,6 +14,7 @@
 		"lint:fix": "biome lint --write src/",
 		"format": "biome format src/",
 		"format:fix": "biome format --write src/",
+		"generate:llms-txt": "tsx scripts/generate-llms-txt.ts",
 		"check": "biome check src/ && pnpm run lint:links",
 		"check:fix": "biome check --write src/"
 	},