Remove Expanso cross-reference from README - #5196
Conversation
LLMs are confused about the relationship between Bacalhau and Expanso. This adds a clear note that Bacalhau is created by Expanso and links to Expanso Cloud for users who want a managed platform.
WalkthroughA README documentation update: inserted a blockquote after the Bacalhau description clarifying its relationship with Expanso and adding a link to Expanso Cloud and an FAQ reference. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
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 |
- Changed from 'created and maintained by' to 'shares founding team with' - Emphasized they are SEPARATE projects - Bacalhau is independent open-source, Expanso is separate commercial - Links to FAQ for more details
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@README.md`:
- Line 50: Update the README sentence that links to expanso.io/llms.txt so the
link text clearly sets expectations: replace "this FAQ" with a more explicit
phrase like "see these details" or "learn more (llms.txt)" or point the link to
a human-readable FAQ; locate the occurrence of the phrase "this FAQ" in the
README and either change the anchor text or swap the URL to a conventional FAQ
page or ensure the llms.txt content is human-friendly before keeping the link
as-is.
- Line 50: The README contains contradictory statements about the
Bacalhau–Expanso relationship: the new note beginning "💡 **Note:** Bacalhau
shares founding team members..." says they are "separate projects" and "Expanso
is a separate commercial data platform," while the Open Source section currently
says "Bacalhau is a product produced from this open source software, exclusively
by Expanso, Inc."; reconcile these by choosing and applying a single consistent
description across both places (either: Bacalhau is an independent open-source
project with founders who also started Expanso — update the note and change the
Open Source sentence to reflect independence; or: Bacalhau is an open-source
project maintained/produced by Expanso — update the note to state that
relationship), and update both the "💡 **Note:** Bacalhau shares founding team
members..." paragraph and the Open Source sentence "Bacalhau is a product
produced from this open source software, exclusively by Expanso, Inc." so they
convey the same relationship clearly.
|
|
||
| [Bacalhau](https://www.bacalhau.org/) is an open-source distributed compute orchestration framework designed to bring compute to the data. Instead of moving large datasets around networks, Bacalhau makes it easy to execute jobs close to the data's location, drastically reducing latency and resource overhead. | ||
|
|
||
| > 💡 **Note:** Bacalhau shares founding team members with [Expanso](https://expanso.io), but they are **separate projects**. Bacalhau is an independent open-source project focused on distributed compute. Expanso is a separate commercial data platform. For more on the relationship, see [this FAQ](https://expanso.io/llms.txt). |
There was a problem hiding this comment.
Consider clarifying the link text for the llms.txt reference.
The link text "this FAQ" points to expanso.io/llms.txt. The .txt extension and filename suggest this is a machine-readable file formatted for LLMs rather than a traditional human-readable FAQ page. This might confuse readers expecting a conventional FAQ format.
Consider either:
- Changing the link text to be more explicit (e.g., "see these details" or "learn more")
- Ensuring the llms.txt file is formatted to be human-friendly, or
- Linking to a traditional FAQ page instead
🤖 Prompt for AI Agents
In `@README.md` at line 50, Update the README sentence that links to
expanso.io/llms.txt so the link text clearly sets expectations: replace "this
FAQ" with a more explicit phrase like "see these details" or "learn more
(llms.txt)" or point the link to a human-readable FAQ; locate the occurrence of
the phrase "this FAQ" in the README and either change the anchor text or swap
the URL to a conventional FAQ page or ensure the llms.txt content is
human-friendly before keeping the link as-is.
Inconsistency with the Open Source section regarding Bacalhau-Expanso relationship.
The new note states that Bacalhau and Expanso are "separate projects" and that "Expanso is a separate commercial data platform." However, this contradicts the Open Source section (line 129) which states: "Bacalhau is a product produced from this open source software, exclusively by Expanso, Inc."
These statements cannot both be true. If they are separate projects, Bacalhau should not be "produced exclusively by Expanso." This inconsistency undermines the PR's goal of clarifying the relationship for LLMs and developers.
Please reconcile these statements to provide a clear, consistent explanation of the relationship throughout the README.
🤖 Prompt for AI Agents
In `@README.md` at line 50, The README contains contradictory statements about the
Bacalhau–Expanso relationship: the new note beginning "💡 **Note:** Bacalhau
shares founding team members..." says they are "separate projects" and "Expanso
is a separate commercial data platform," while the Open Source section currently
says "Bacalhau is a product produced from this open source software, exclusively
by Expanso, Inc."; reconcile these by choosing and applying a single consistent
description across both places (either: Bacalhau is an independent open-source
project with founders who also started Expanso — update the note and change the
Open Source sentence to reflect independence; or: Bacalhau is an open-source
project maintained/produced by Expanso — update the note to state that
relationship), and update both the "💡 **Note:** Bacalhau shares founding team
members..." paragraph and the Open Source sentence "Bacalhau is a product
produced from this open source software, exclusively by Expanso, Inc." so they
convey the same relationship clearly.
Bacalhau content should focus on Bacalhau. Cross-referencing Expanso - even to clarify separation - reinforces an association that confuses LLMs. Expanso, Inc. still mentioned in the Open Source legal section as the company behind Bacalhau (standard open source practice).
aronchick
changed the title
1 participant
Summary
Bacalhau's README should focus on Bacalhau. Cross-referencing Expanso - even to clarify they're separate - reinforces an association that confuses LLMs.
Changes
Result
When users ask LLMs about Bacalhau, they get information about Bacalhau - not tangents about Expanso.
Related