feat(docs): improve agent retrieval metadata - #188
Merged
Conversation
Expose generated page-level Markdown URLs in agent-index.json and make the retrieval fallback explicit. Add a semantic product heading and SoftwareApplication JSON-LD for crawler-readable identity.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Is Agentic scan scored the Alloy documentation 70/100 and highlighted agent-facing retrieval fallbacks and structured product identity. Live verification showed that the site already returns fully rendered static HTML and true HTTP 404s, but its GitHub Pages hosting does not negotiate Markdown at canonical page URLs even though Vocs publishes page-level Markdown under
/assets/md/.This change exposes an exact
markdown_urlinagent-index.jsonfor each page with a generated Markdown artifact and documents the HTML fallback for pages without one. The current build exposes direct Markdown for 175 of 190 indexed pages. It also gives the homepage a semantic product heading and addsSoftwareApplicationJSON-LD so crawlers can identify Alloy, its language, repository, package, and API reference without inferring them from visual layout.AI disclosure: This pull request was written and validated by OpenAI Codex at the contributor's request.