Skip to content

Commit

Permalink
Fix broken docs (#230)
Browse files Browse the repository at this point in the history
* chore: try to fix

* chore: fix attempt

* chore: attempt

* chore: attempt to fix

* chore: attempt to fix
  • Loading branch information
anxolin authored Jan 2, 2025
1 parent 6d77cfe commit c379396
Show file tree
Hide file tree
Showing 3 changed files with 978 additions and 14 deletions.
4 changes: 2 additions & 2 deletions README.md
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
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",
"eslint": "^8.33.0",
"eslint-config-prettier": "^8.6.0",
"eslint-plugin-prettier": "^4.2.1",
Expand Down
Loading

0 comments on commit c379396

Please sign in to comment.