chore: update readme examples

[crutch12]

Summary

README.md has irrelevant example commands (e.g. yarn ui:build) and outdated links.

Fixed:

• updated README.md and some package.json scripts

To Test

1. Check README.md

Summary by CodeRabbit

• Documentation

  • Restructured SDK preview setup instructions and clarified development workflow steps.
  • Updated Widget Configurator URL from 127.0.0.1 to localhost.
  • Enhanced development documentation with updated test command references and unified e2e workflow guidance.
  • Corrected minor documentation formatting in library references.

• Chores

  • Added interactive end-to-end testing mode to development tooling.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[vercel]

@crutch12 is attempting to deploy a commit to the cow Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

Documentation and configuration updates to reflect a unified end-to-end test workflow transition, including updated URLs, internal link references, and new interactive e2e mode configuration. Minor text corrections applied across multiple README files.

Changes

Cohort / File(s)	Summary
Documentation Updates README.md, libs/abis/README.md	Updated README.md with table formatting, SDK preview instructions, widget configurator URL, test workflow migration from Cypress to e2e, build/analyze section reorganization, and internal link path updates (amountFormat reference and AppData metadata). Fixed parenthesis typo in libs/abis/README.md.
E2E Configuration apps/cowswap-frontend-e2e/project.json, package.json	Added new e2e:open target in project.json with Cypress executor configuration (watch, headed, openMode flags). Added corresponding e2e:open npm script in package.json mapping to nx run-many -t e2e:open.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Documentation changes are primarily content updates, formatting, and link corrections (low complexity)
• Configuration additions are straightforward new entries without complex logic
• No interdependent changes requiring broader codebase understanding
• Focus areas: Verify URL correctness, confirm internal link paths are accurate, and ensure e2e configuration aligns with existing Cypress setup

Suggested reviewers

• shoom3301
• alfetopito
• elena-zh

Poem

🐰 The docs now dance in fresh new light,
E2E workflows opening bright!
From Cypress paths to interactive ways,
Our tests now hop through modern days,
Small fixes hopped in, everything's right! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	The description is incomplete. It lacks a 'Background' section and the 'To Test' section is minimal with only one vague step that doesn't provide testable criteria.	Expand 'To Test' with specific verification steps and checkboxes (e.g., verify Widget Configurator URL works, check CoW Protocol entry, verify e2e scripts function). Optionally add 'Background' explaining why these updates were needed.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'chore: update readme examples' directly reflects the main change: updating README documentation and examples with corrected commands and links.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ce4d7e3 and 29befdd.

📒 Files selected for processing (4)

• README.md (8 hunks)
• apps/cowswap-frontend-e2e/project.json (1 hunks)
• libs/abis/README.md (1 hunks)
• package.json (1 hunks)

🧰 Additional context used

🧠 Learnings (4)

📚 Learning: 2025-07-18T08:07:55.497Z

Learnt from: alfetopito
Repo: cowprotocol/cowswap PR: 5992
File: libs/tokens/src/const/tokensList.json:135-167
Timestamp: 2025-07-18T08:07:55.497Z
Learning: Token lists for CoW Swap are maintained in a separate repository at https://github.com/cowprotocol/token-lists, not in the main cowswap repository. Issues related to missing token lists should be tracked in the token-lists repository.

Applied to files:

• README.md

📚 Learning: 2025-09-11T08:25:51.460Z

Learnt from: alfetopito
Repo: cowprotocol/cowswap PR: 6234
File: libs/tokens/src/index.ts:1-4
Timestamp: 2025-09-11T08:25:51.460Z
Learning: In the cowprotocol/cowswap project, there is currently no SSR (Server-Side Rendering) support, so localStorage access at module import time does not cause SSR-related issues.

Applied to files:

• README.md

📚 Learning: 2025-02-20T15:59:33.749Z

Learnt from: shoom3301
Repo: cowprotocol/cowswap PR: 5443
File: apps/cowswap-frontend/src/modules/swap/containers/ConfirmSwapModalSetup/index.tsx:71-71
Timestamp: 2025-02-20T15:59:33.749Z
Learning: The swap module in apps/cowswap-frontend/src/modules/swap/ is marked for deletion in PR #5444 as part of the swap widget unification effort.

Applied to files:

• README.md

📚 Learning: 2025-05-26T12:39:29.009Z

Learnt from: cowdan
Repo: cowprotocol/cowswap PR: 5715
File: libs/common-const/src/tokens.ts:539-555
Timestamp: 2025-05-26T12:39:29.009Z
Learning: The team accepts using NATIVE_CURRENCY_ADDRESS as a temporary placeholder for COW token contract addresses on new networks (Polygon, Avalanche) until actual COW contracts are deployed.

Applied to files:

• README.md

🔇 Additional comments (12)

libs/abis/README.md (1)

3-3: ✓ Punctuation fix is correct.

The change from mismatched ")types" to matched "(types" corrects a clear typographical error in the documentation.

package.json (1)

38-38: ✓ New e2e:open script is consistent with the project configuration.

The Cypress open mode enables interactive testing where specs can be run and the Command Log updated in real time. The new script aligns with the corresponding e2e:open target added to project.json.

apps/cowswap-frontend-e2e/project.json (1)

14-23: ✓ New e2e:open target enables interactive Cypress development workflow.

The Cypress open mode enables interactive testing through an interactive workflow where specs can be run and the Command Log updated in real time. The configuration with watch: true, headed: true, and openMode: true properly enables this interactive development experience.

README.md (9)

10-10: ✓ Table formatting is consistent with Markdown standards.

The header separator lines use standard dashes for Markdown table formatting.

Also applies to: 234-234

---

14-14: ✓ CoW Protocol entry is a useful addition to the links table.

Adding the CoW Protocol main website link provides better discoverability for users.

---

31-34: ✓ SDK preview instructions are clearer and more accurate.

The reformatted instructions now explicitly mention the PACKAGE_READ_AUTH_TOKEN environment variable and its required permissions, which improves guidance for developers who need to work with preview SDK versions.

---

94-94: ✓ Localhost is the conventional choice over 127.0.0.1.

Changing from http://127.0.0.1:4200/widget-configurator to http://localhost:4200/widget-configurator follows standard development conventions and is more readable.

---

126-127: ✓ Integration test workflow documentation aligns with the e2e changes.

The updated commands (yarn e2e and yarn e2e:open) match the new npm scripts and project targets introduced in the PR, creating a consistent unified e2e workflow.

Also applies to: 134-135

---

137-144: ✓ New Analyze build section documents bundle analysis capability.

The section clearly documents the environment variables and available templates for bundle analysis, which is helpful for developers looking to optimize build size.

---

248-248: ✓ AppData package reference correctly updated to the new location.

The @cowprotocol/app-data project has been migrated to the cow-sdk mono repo and is now published as @cowprotocol/sdk-app-data. This update reflects the current package structure.

---

257-259: ✓ Sitemap documentation update is more concise and informative.

The new documentation links directly to the configuration file and clarifies that yarn build:cowfi generates the sitemap, which is more actionable than the previous step-by-step approach.

---

292-294: Verify the updated documentation link exists at the new path.

Line 293 updates the Amounts formatting reference from apps/cowswap-frontend/src/utils/amountFormat/README.md to libs/common-utils/src/amountFormat/README.md. Confirm the new path exists and contains the expected documentation, and verify the old path has been removed or properly migrated.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[shoom3301]

Thanks a lot!