Repository navigation
dev site is more agent friendly - #1771
Open
shadromani wants to merge 6 commits into
Open
shadromani wants to merge 6 commits into
shadromani wants to merge 6 commits into
Conversation
The spell check globs every Markdown file in the tree, so it read Hugo's build output under public/ and the personal CLAUDE.local.md, neither of which git tracks. A word in either failed the commit hook. Reuse .gitignore for the spell check, and list CLAUDE.local.md there. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
The Markdown output of the schema shortcodes was an HTML table with Markdown links inside its cells. A link inside raw HTML never renders, so 121 links across three reference pages showed as literal brackets. The check marks were the only text that said which services return a field. The Markdown must keep that information. Each field is now a level-four heading followed by its type, its value note, and the services that return it, then the description as written. A heading can hold paragraphs, lists, and tables, which a table cell cannot. A response field that no service returns is a content error, so the build fails on it. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
A reader of index.md could not tell which page it was: the file had no title, no URL, and no heading. Section pages pasted each child's HTML summary under a duplicated heading, and formatter markers leaked from the source. Four pages had no Markdown at all: the home page, both release notes indexes, and the server IP addresses page. Every page now opens with front matter (title, description when set, URL of the HTML page) and an H1. Section pages list their child pages as links instead of pasting summaries. The home page lists every page by section. Taxonomy pages no longer build Markdown, as the site uses no tags. Alerts inside snippets reached the output as literal shortcode tokens, and the clean-alerts partial stripped them along with the warning label. The snippet shortcode now renders them through the same partial as the alert shortcode, which quotes every line so the whole alert stays inside the blockquote. An alert of an unknown kind fails the build instead of rendering as a plain note. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
The head of each HTML page names its Markdown version in a rel=alternate link, which an agent that sends no Accept header, such as Codex, follows. A person or an HTML-to-text converter sees only the page body, and nothing there says a Markdown version exists. Add a "View as Markdown" link beside the copy button. On a release note it follows the date line, where the copy button also goes. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
An agent that starts at the site root has no index of the pages and no way to fetch the whole site at once. The site also had no robots.txt. Hugo builds llms.txt from the page list as a second output format of the home page. After Hugo, build.sh concatenates every page's Markdown into llms-full.txt, about 1.1 MB. The script fails the build when a page's Markdown holds a link inside an HTML block, which never renders, an unrendered shortcode, or a Prettier marker. Hugo also empties public/ before it builds, so a stale page from an earlier build cannot end up in the file. The Markdown pages and the two llms files carry X-Robots-Tag: noindex so they stay out of search results, where they would duplicate the HTML pages. robots.txt allows everything and names the sitemap. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
The site index listed the device tracking pages as Android, iOS, and Web, with no product. An agent that picks a link by its text could not tell what the pages cover. The Markdown indexes now use the link title, and these three pages set one. The HTML pages and the sidebar menus keep their titles. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configuration
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
shadromani
changed the title
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.
No description provided.