docs: improve agentic discovery score#779
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
1e459da to
23f4532
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1e459da3ce
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| "/.well-known/*", | ||
| "/api/api-catalog", | ||
| "/api/openapi.json", | ||
| "/assets/md/*", |
There was a problem hiding this comment.
Add advertised root files to allowedPaths
The new agent index and API catalog advertise /AGENTS.md and /agent-permissions.json as primary agent-readable discovery files, but this allowlist only permits /, /.well-known/*, API docs, markdown mirrors, and llms files. If an agent enforces allowedPaths after reading this policy, the advertised instructions and permission document fall outside the allowed read surface, which self-blocks the discovery flow this file is meant to enable.
Useful? React with 👍 / 👎.
23f4532 to
88f3be1
Compare
Motivation
Improve agent-readability and discovery for the documentation site. The
agentic-seo --output-dir dist/publicscore improves from61/100(C) before to97/100(A) after.Summary
AGENTS.md,agent-permissions.json, and a compactagent.htmlentry pointmppxskill metadata with capabilities, inputs, constraints, and documentation linksllms.txtso the short index stays under the 5K-token targetKey design considerations
llms.txtrewrite in Vite so Vocs remains the source generator while the emitted artifact is optimized for agentsllms.txtduring local development when a build artifact exists, so local audits match production outputagent.htmlas a low-noise HTML bridge for scanners and agents without changing the Vocs runtime route model