Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,15 @@ This command generates static content into the `build` directory and can be serv
bun run build
```

## AI / agent exports

The build also generates AI-friendly artifacts that will be served by the hosted site:

- `build/llms.txt` (served as `/llms.txt`)
- `build/ai/manifest.json` (served as `/ai/manifest.json`)
- `build/ai/docs.jsonl` (served as `/ai/docs.jsonl`)
- `build/ai/raw/` (served as `/ai/raw/`)

## Configure .env

The docs site pulls data from on-chain smart contracts, so an API key is necessary. The default is an Alchemy API key so the easiest thing to do is get a free api key from them at https://www.alchemy.com/pricing.
Expand Down
8 changes: 8 additions & 0 deletions bun.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"get-branch-name": "git rev-parse --abbrev-ref HEAD > .branch-name",
"start": "bun run runAddressCheck && bun run get-branch-name && BRANCH_NAME=$(cat .branch-name) IS_DEV=true docusaurus start",
"start-no-check": "bun run get-branch-name && BRANCH_NAME=$(cat .branch-name) IS_DEV=true docusaurus start",
"build": "docusaurus build",
"build": "docusaurus build && bun scripts/generateAiArtifacts.ts",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
Expand Down Expand Up @@ -45,6 +45,8 @@
"remark-math": "^6.0.0",
"solc": "^0.8.31",
"solidity-docgen": "^0.5.17",
"turndown": "^7.1.2",
"turndown-plugin-gfm": "^1.0.2",
"viem": "^2.41.2"
},
"browserslist": {
Expand Down
2 changes: 1 addition & 1 deletion scripts/fetchedAddressData.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"timeLastChecked": 1766510970,
"timeLastChecked": 1767199169,
"addressesData": {
"v3ContractAddresses": {
"topLevel": {
Expand Down
Loading