Skip to content

feat: improve limit order deeplinks - #669

Open
kernelwhisperer wants to merge 8 commits into
mainfrom
feat/limit-order-deeplinks
Open

kernelwhisperer wants to merge 8 commits into
mainfrom
feat/limit-order-deeplinks

Conversation

@kernelwhisperer

@kernelwhisperer kernelwhisperer commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

Description

Expand the CoW Swap deeplink guide so users and AI agents can create limit-order links with the correct amounts and order kind.

Part of: https://linear.app/cowswap/issue/FE-615/publish-an-llm-discoverable-deep-link-guide-for-limit-orders

The docs changes are been benchmarked in this eval PR: https://github.com/cowprotocol/skills/pull/52.

Changes

  1. Document exact-buy/sell links, price conversion, token units, and unsupported settings.
  2. Add concise AI-agent tips and link the guide from the limit-order tutorial.
  3. Enable per-page Markdown exports and update the LLM plugin to fix export paths.

Before, if you clicked on View as Markdown, it took you to GH:

image

Now, if you click on View as Markdown, it takes you to docs.cow.fi/<page>.md.
This should help with SEO and improve agent use. (Especially since GH now does heavy rate limited)

This also applies to links in llms.txt, they now have the .md suffixes: https://docs-git-feat-limit-order-deeplinks-cowswap.vercel.app/llms.txt

To Test

  1. Prompt Claude or Codex with
Read from https://docs-git-feat-limit-order-deeplinks-cowswap.vercel.app/ so I can ask questions about it
help me place a gnosis limit order selling exactly 2 eth for at least 6000 usdc

Prod response misses the deeplink - Branch preview has the correct deeplink

Warning

Codex seems to have trouble opening the .md files.
I tried fixing it by changing the mime type to plaintext, to no avail.

Summary by CodeRabbit

  • Documentation
    • Rewrote the CoW Swap deeplink guide with instructions for creating prefilled swap and limit-order links, including amount and price calculations.
    • Clarified which settings links support, what users should review before signing, and how to share the original link.
    • Added guidance on creating prefilled limit-order links to the limit-order tutorial.

Summary by CodeRabbit

  • Documentation
    • Reworked the CoW Swap deeplink guide with examples for swap and limit orders, amount calculations, and supported settings.
    • Added guidance on creating prefilled limit-order links and reviewing order settings before signing.
  • New Features
    • Added Markdown exports for supported documentation pages and made them available through AI assistant actions. When an export is unavailable, AI prompts use the page URL instead.

@kernelwhisperer
kernelwhisperer requested a review from a team as a code owner October 15, 2026 11:38
@vercel

vercel Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
docs Ready Ready Preview Oct 15, 2026 1:33pm UTC

Request Review

@socket-security

socket-security Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Updateddocusaurus-plugin-llms@​0.3.0 ⏵ 0.6.199 +1310091 -990 +4100

View full report

@coderabbitai

coderabbitai Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: f5949b1e-17ed-4e3d-9877-aff7957820b6
📥 Commits

Reviewing files that changed from the base of the PR and between 192c6f1 and 437dbfd.

📒 Files selected for processing: 4
  • docusaurus.config.ts
  • src/components/AiActionsDropdown/index.tsx
  • src/theme/DocItem/Content/index.tsx
  • vercel.json
🚧 Files skipped from review as they are similar to previous changes: 1
  • docusaurus.config.ts

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

The pull request expands CoW Swap deeplink guidance for swap and limit orders. It also updates Markdown export generation, serving, and documentation actions.

Changes: CoW Swap deeplinks

Layer / File(s) Summary
Deeplink parameters
docs/cow-protocol/tutorials/cow-swap/custom-links.md
The guide describes swap and limit-order URLs, supported parameters, amount units, and the orderKind default.
Limit-order guidance
docs/cow-protocol/tutorials/cow-swap/custom-links.md, docs/cow-protocol/tutorials/cow-swap/limit.mdx
The guide adds price-bound examples, manual setup instructions for expiry and partial fills, and guidance for reviewing and sharing links. The limit-order page links to the guide.

Markdown exports

Layer / File(s) Summary
Markdown generation and serving
package.json, docusaurus.config.ts, vercel.json
The docusaurus-plugin-llms dependency is pinned to 0.6.1. Its configuration enables Markdown generation and disables directory structure preservation. Vercel serves .md paths as plain text.
Markdown action URLs and copy fallback
src/components/AiActionsDropdown/index.tsx, src/theme/DocItem/Content/index.tsx
The dropdown derives Markdown URLs from the current route and uses them for prompts, viewing, and copying. If an export is unavailable, copying retains the article text. The document content component no longer passes edit URLs.

Priority: ⬇️ Low

Estimated code review effort: 3 (Moderate) | ~20 minutes

Change: Feature

Sequence Diagram(s)

sequenceDiagram
  participant DocItemContent
  participant AiActionsDropdown
  participant MarkdownExport
  DocItemContent->>AiActionsDropdown: render without editUrl
  AiActionsDropdown->>MarkdownExport: fetch derived Markdown URL
  MarkdownExport-->>AiActionsDropdown: return Markdown or unavailable response
  AiActionsDropdown->>AiActionsDropdown: copy Markdown or retain article text
Loading

Suggested reviewers: fleupold

Merge Risk: ⚪ Minimal · up to 437db

This change expands deeplink documentation and updates Markdown export links. No concrete merge-blocking risk was established; confirm on the preview deployment that nested pages serve their .md paths.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 3 files. (1 skipped: 1 … Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed Passed checks: 4 passed
Check name Status Explanation
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.
Title check Passed The title clearly identifies the main change: improving CoW Swap limit-order deeplinks. It is concise and relevant to the changeset.
Description check Passed The description follows the required template and explains the purpose, implementation changes, testing steps, related work, and known limitations. It provides sufficient context for review.
Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 3 files. (1 skipped: 1 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches: 💡 1
📝 Generate docstrings: 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@linear-code

linear-code Bot commented Oct 15, 2026

Copy link
Copy Markdown

FE-615

@kernelwhisperer kernelwhisperer changed the title Feat/limit order deeplinks feat: improve limit order deeplinks Oct 15, 2026

This branch was successfully deployed

1 active deployment
Preview — 9ea6dd2a Deployed Oct 15, 2026 by vercel[bot]
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