Skip to content

Commit 65c3e0f

Browse files
committed
fix: forge doc assumes the top-level folder when linking to the github repo
1 parent 1eae9fe commit 65c3e0f

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

contracts/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
"watch": "hardhat watch",
3232
"docgen": "hardhat docgen",
3333
"docserve": "scripts/docPreprocess.sh && forge doc --serve",
34-
"docbuild": "scripts/docPreprocess.sh && forge doc --build --out dist",
34+
"docbuild": "scripts/docPreprocess.sh && forge doc --build --out dist && scripts/docPostprocess.sh",
3535
"publish": "yarn npm publish --access public --tag $(cat package.json | jq .version)"
3636
},
3737
"devDependencies": {

contracts/scripts/docPostprocess.sh

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#!/usr/bin/env bash
2+
3+
SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
4+
5+
# Forge doc assumes that the code is in the top-level folder.
6+
# We need to add contracts/ to the path
7+
find $SCRIPT_DIR/../dist -type f \( -name "*.md" -o -name "*.html" \) \
8+
| xargs sed -i "" 's|\(github.com/kleros/kleros-v2/.*\)\(/src\)|\1/contracts\2|g'
9+

0 commit comments

Comments
 (0)