Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken docs #230

Merged
merged 5 commits into from
Jan 2, 2025
Merged

Fix broken docs #230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1482e3b
chore: try to fix
anxolin Jan 2, 2025
9c9ecef
chore: fix attempt
anxolin Jan 2, 2025
e5208d1
chore: attempt
anxolin Jan 2, 2025
517f714
chore: attempt to fix
anxolin Jan 2, 2025
2e7b7b3
chore: attempt to fix
anxolin Jan 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
yarn add @cowprotocol/cow-sdk
```

## [Trading SDK](./src/trading/README.md)
## [Trading SDK](https://github.com/cowprotocol/cow-sdk/blob/main/src/trading/README.md)

CoW Protocol is intent based, decentralized trading protocol that allows users to trade ERC-20 tokens.

Expand Down Expand Up @@ -62,7 +62,7 @@ console.log('Order created, id: ', orderId)
This example is the simplest way to trade on CoW Protocol.

You might want to use more advanced parameters like `receiver`, `partiallyFillable`, `validTo` and others.
Check the [Trading SDK documentation](./src/trading/README.md) for more details.
Check the [Trading SDK documentation](https://github.com/cowprotocol/cow-sdk/blob/main/src/trading/README.md) for more details.


## Other utilities
Expand Down
4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
"prebuild": "rm -rf dist && yarn run codegen",
"build": "microbundle -f modern,esm,cjs",
"start": "microbundle -f modern,esm,cjs watch",
"postbuild": "cp package.json dist && cp README.md dist && yarn run trading:generateSchemas",
"copy-md-files": "npx cpx \"**/*.md\" dist",
"postbuild": "cp package.json dist && yarn copy-md-files && yarn run trading:generateSchemas",
"lint": "eslint src",
"format": "prettier --write \"src/**/*.+(ts|json)\"",
"test": "jest",
Expand Down Expand Up @@ -60,6 +61,7 @@
"@typescript-eslint/parser": "^5.51.0",
"babel-plugin-inline-import": "^3.0.0",
"coveralls": "^3.1.1",
"cpx": "^1.5.0",
Copy link
Contributor

Choose a reason for hiding this comment

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

Why cpx rather than pure cp?
AFACIT, cpx would be useful for watching file changes, but that's not needed here.

"eslint": "^8.33.0",
"eslint-config-prettier": "^8.6.0",
"eslint-plugin-prettier": "^4.2.1",
Expand Down
Loading
Loading