docs: add related-site and optional sections to llms.txt, dedupe developer docs - #511
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Warning Review limit reached
Next review available in: 17 minutes Limit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?Wait for the limit to reset, then comment An organization admin can change what happens after included review limits in Billing. How do review limits work?CodeRabbit enforces per-developer PR review limits within each organization. For paid Pro and Pro+ reviews, CodeRabbit uses a developer's included PR review attempts over the past 7 days to set the current hourly allowance. At typical activity levels, the full plan allowance applies. Higher sustained activity can lower the allowance until earlier attempts leave the 7-day window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
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 |
…loper docs Both llms.txt files only listed their own site, so an agent reading docs.plane.so had no pointer to the API reference, webhooks, MCP server or self-hosting docs (and vice versa) — one of the is-agentic discoverability findings. Following the llmstxt.org layout: - custom template on both sites adds `## Related documentation` (the other Plane docs site's llms.txt plus its key entry pages) and `## Optional` (llms-full.txt, sitemap.xml, GitHub, plane.so) - `details` now tells agents every page is available as Markdown via `.md` or `Accept: text/markdown` - developer-docs: drop the "/" shortcut sidebar from the llms.txt table of contents — its four groups repeated 14 pages that the section sidebars already list, so every page now appears exactly once - docs vercel.json: send the same `</llms.txt>; rel="describedby"` Link header that developer-docs already sends Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CsPSwTnpsEb5c5Ud2CLrL8
5673e37 to
f21372e
Compare
2 participants
Summary
Item 4 from the
is-agenticscan (independent of #508–#510).Problem. Each site's
llms.txtonly listed its own pages. An agent reading docs.plane.so got no pointer to the API reference, webhooks, MCP server, or self-hosting docs on developers.plane.so (and vice versa) — which is what the scan's Developer resource discoverability finding asks for ("list them in llms.txt"). The developer-docs file also listed 14 pages twice, and docs.plane.so didn't send the</llms.txt>; rel="describedby"Link header that developers.plane.so already does.Change (both sites, consistent), checked against the llmstxt.org format (H1 + blockquote, H2 link sections,
Optional, no duplicates, valid links):customLLMsTxtTemplate— H1, blockquote, details, then H2 link sections:## Table of Contents— the generated sidebar index (unchanged)## Related documentation— the other Plane docs site'sllms.txtplus its key entry pages (docs → API reference, webhooks, MCP server, self-hosting; developer docs → core concepts, quickstart, roles & permissions)## Optional—llms-full.txt,sitemap.xml, GitHub, plane.so (the spec's "skippable" section)detailsnow says every page is available as Markdown via.mdorAccept: text/markdown./sidebar only holds shortcut groups that repeat pages from the section sidebars; it's dropped from the llms.txt TOC via the plugin'ssidebarhook, so every page appears exactly once (371 links / 357 unique → 365 / 365).vercel.json: add</llms.txt>; rel="describedby"; type="text/plain"to the Link header (matches developer-docs).Verification
pnpm check:types/check:format/pnpm buildpass.dist/llms.txton both sites: single blockquote, H2 sectionsTable of Contents | Related documentation | Optional, 0 duplicate URLs (137 links docs, 365 developer-docs).Not changed — needs a content decision
developer-docs has an
### Otherbucket at the end of the TOC for pages in no sidebar:api-reference/inbox-issue/*(looks like the pre-rename twin ofapi-reference/intake-issue/*, same six pages),api-reference/work-item-relations/*, andself-hosting/methods/one-click. They're live, indexable pages so I left them listed. Ifinbox-issueis legacy it should probably be redirected/removed, and the other two likely want sidebar entries — happy to do that as a separate PR.Checklist
llms.txtsections + dedupe — this PRopenapi.jsonon developers.plane.so — blocked on a spec sourcenpx is-agenticon both hosts once deployed🤖 Generated with Claude Code
https://claude.ai/code/session_01CsPSwTnpsEb5c5Ud2CLrL8