Skip to content

Update intents.md#633

Open
pretf00d wants to merge 1 commit into
mainfrom
pretf00d-patch-7
Open

Update intents.md#633
pretf00d wants to merge 1 commit into
mainfrom
pretf00d-patch-7

Conversation

@pretf00d
Copy link
Copy Markdown
Contributor

@pretf00d pretf00d commented Jun 2, 2026

updated docs as per Odran's instructions

Description

Changes

  • ...
  • ...

Summary by CodeRabbit

  • Documentation
    • Updated the Intents introduction with clarified definitions of intents as non-executable signed trading constraints, revised explanations of financial and technical benefits, and improved descriptions of how solvers interact with the system.

updated docs as per Odran's instructions
@pretf00d pretf00d requested a review from a team as a code owner June 2, 2026 11:12
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 2, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Jun 2, 2026 11:12am

Request Review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 2, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR updates the Intents introduction documentation to clarify how CoW Protocol defines intents as non-executable signed constraints, reframe the financial benefits around independent solver competition and batched settlements with uniform clearing prices, and adjust technical benefit language to focus on solver construction of settlement solutions across multiple transaction types.

Changes

Intents Concept Documentation

Layer / File(s) Summary
Intent definition and benefits narrative
docs/cow-protocol/concepts/introduction/intents.md
Rewrites the intent definition paragraph, reframes Financial Benefits to emphasize separation of intent expression from settlement optimization and uniform clearing price MEV protection, and updates Technical Benefits to describe solver solution construction across transaction types without product examples.

Poem

In a protocol where intents express the way,
Solvers compete to find the brightest day.
No paths prescribed, just pure constraint's call—
Batched settlements protect the traders all! 🐰✨

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description lacks substantive content; it only contains a vague reference to 'Odran's instructions' and placeholder template sections without concrete change details or context. Complete the Description section with context for why changes were needed, and populate the Changes section with actual bullet points summarizing the modifications made to intents.md.
Title check ❓ Inconclusive The title 'Update intents.md' is vague and does not convey the substantive nature of the changes, such as clarifying intent definitions or revising benefit explanations. Consider a more descriptive title that highlights the main change, such as 'Clarify intent definitions and financial benefits in CoW documentation' to better communicate the content updates to reviewers.
✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch pretf00d-patch-7

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/cow-protocol/concepts/introduction/intents.md`:
- Line 16: Change the inconsistent British/American spelling by replacing
"optimisation" with "optimization" in the sentence that begins "Thanks to its
intent-based architecture, CoW Protocol separates user intent expression from
settlement-route optimisation." (the line containing "optimisation" and the
adjacent sentence referencing "solvers") so the document consistently uses the
American spelling "optimization" throughout; search for both "optimisation" and
"optimization" in this document and make all occurrences match the chosen
variant.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 32a048d4-795b-472a-9a4c-e2fe0d028411

📥 Commits

Reviewing files that changed from the base of the PR and between 978e255 and 896dd16.

📒 Files selected for processing (1)
  • docs/cow-protocol/concepts/introduction/intents.md

When a user places a trade directly on-chain, the execution path is set in stone and the trader receives whatever price (+/- slippage) the AMM or aggregator they're trading on gives them.

Thanks to its intent-based architecture, CoW Protocol delegates the job of finding the optimal execution path to professional third parties known as [solvers](./solvers).
Thanks to its intent-based architecture, CoW Protocol separates user intent expression from settlement-route optimisation. Independent [solvers](./solvers) compete to find valid settlement paths that satisfy user-signed constraints.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Standardize spelling: "optimisation" vs "optimization".

Line 16 uses British spelling "optimisation" while line 21 uses American spelling "optimization". Pick one variant and use it consistently throughout the document.

📝 Proposed fix to standardize to American spelling
-Thanks to its intent-based architecture, CoW Protocol separates user intent expression from settlement-route optimisation. Independent [solvers](./solvers) compete to find valid settlement paths that satisfy user-signed constraints. 
+Thanks to its intent-based architecture, CoW Protocol separates user intent expression from settlement-route optimization. Independent [solvers](./solvers) compete to find valid settlement paths that satisfy user-signed constraints.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Thanks to its intent-based architecture, CoW Protocol separates user intent expression from settlement-route optimisation. Independent [solvers](./solvers) compete to find valid settlement paths that satisfy user-signed constraints.
Thanks to its intent-based architecture, CoW Protocol separates user intent expression from settlement-route optimization. Independent [solvers](./solvers) compete to find valid settlement paths that satisfy user-signed constraints.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/cow-protocol/concepts/introduction/intents.md` at line 16, Change the
inconsistent British/American spelling by replacing "optimisation" with
"optimization" in the sentence that begins "Thanks to its intent-based
architecture, CoW Protocol separates user intent expression from
settlement-route optimisation." (the line containing "optimisation" and the
adjacent sentence referencing "solvers") so the document consistently uses the
American spelling "optimization" throughout; search for both "optimisation" and
"optimization" in this document and make all occurrences match the chosen
variant.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant