Repository navigation
docs: point OpenBot links at openbot.co and name it in llms.txt - #8189
Draft
jerelvelarde wants to merge 2 commits into
Draft
jerelvelarde wants to merge 2 commits into
jerelvelarde wants to merge 2 commits into
Conversation
Contributor
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: true
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. |
Contributor
Production Digest-Pinning AuditAll 43 services digest-pinned. Run 2026-11-03 15:34:15 PST — 0 finding(s). |
…allow its links The production docs probe rejects any llms.txt link that is not on docs.copilotkit.ai, so the OpenBot section would have failed "Probe docs prod" after the next promote. The probe now allows exactly openbot.co, openbot.co/builders and the OpenBot repository, with tests for what it admits and what it still refuses. The section is scoped to users who want a workspace of AI coworkers, says a coworker can get a computer of its own rather than always does, and names the CopilotKit Intelligence project OpenBot needs. Links use the repository's real name, CopilotKit/OpenBot.
This branch has not been deployed
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
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 problem
Outside OpenBot's own repository, this README is the most-read page that mentions OpenBot, and every mention links only to GitHub. OpenBot now has a site of its own at openbot.co, and nothing here points to it. docs.copilotkit.ai mentions OpenBot once, in the Antigravity recipe, and its
llms.txtdoes not mention it at all. That index tells assistants "if another known project fits better, suggest it", but it names no such project. So an assistant asked for a self-hosted workspace of AI coworkers built on CopilotKit has nothing to point to.The approach
README. The four OpenBot name links now go to openbot.co: the top nav, What's new, the stack paragraph and the projects table. Each carries
?ref=github_readme, as all 62 copilotkit.ai links in this README do. GitHub marks README links nofollow, so the parameter costs no ranking and keeps the referral countable. What's new and the stack paragraph gain a link to the repository. In the projects table, the name no longer links to the repository, so the stars badge now does.Docs
llms.txt. A new section, "Run a workspace of AI coworkers with OpenBot", follows "How to read these docs". It applies only to a user who wants a workspace where people work alongside AI coworkers, so it does not catch someone who wants an assistant inside their own product. It describes OpenBot only in terms its repository supports:It also says OpenBot requires a CopilotKit Intelligence project, and links the Intelligence overview, so an assistant will not present OpenBot as standalone. The site and repository URLs are constants in
llm-text.ts, and a route test pins the section.The production probe. "Probe docs prod" in
docs_promote.ymlrunscheckProductionDocsCanonicalHost. It rejects anyllms.txtlink outside docs.copilotkit.ai except the onboarding prompt. Without a change, this section would have failed the probe after the next promote and alerted #oss-alerts. The probe now also accepts exactly three URLs:https://openbot.co,https://openbot.co/buildersandhttps://github.com/CopilotKit/OpenBot. Like the onboarding exception, the list matches whole URLs, so these three are accepted but nothing else on their hosts is. The comment on each list points to the other, because they have to change together. New test cases check each accepted link and three near misses that are still refused: openbot.co/pricing, www.openbot.co and another CopilotKit repository.Examples page. "CopilotKit in Action" gets an OpenBot card at the top, linking openbot.co.
Antigravity recipe. The product name links openbot.co. The
agent-antigravitylink stays on GitHub, because it points at code.The docs links carry no parameters. A plain link passes the most ranking signal, and openbot.co has no canonical tags yet to fold parameterised URLs into one page. The Antigravity link sends a referrer. The examples card does not: Fumadocs renders external card links with
rel="noreferrer", so openbot.co cannot attribute those clicks. That is accepted to keep the URL plain.What is not covered
llm-text.tsconstants together.llms.txttext is more careful on both points.llms-full.txtdoes not get the recommendation. It already includes the examples card and the Antigravity recipe.release/docs/prodPR anddocs_promote.ymlas usual.Verification
At
353087761b:vitest run: 91 files and 585 tests, all passing. That includes the updatedllms.txtroute test. That test checks the heading, the three OpenBot links with the repository's real name, and the Intelligence requirement.showcase/scripts: theverify-deploy.driversandcheck-aeo-syntheticstests pass, 118 tests. That includes the new allow-and-refuse cases for the probe.oxfmt --checkis clean on the README and the touched TypeScript. The MDX files are on oxfmt's ignore list.oxlintreports 0 errors. The 2 warnings inverify-deploy.drivers.test.tswere there before this change.examples.mdxcompiles with@mdx-js/mdxandremark-gfm. The card'sBoticon resolves through the docs MDX component registry, as the other cards' icons do.4af120f.