Uniswap v4 Technical Reference #781
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
saucepoint
commented
Sep 27, 2024
There was a problem hiding this comment.
the file to review / provide feedback on
marktoda
approved these changes
Sep 30, 2024
scripts/v4-forge-doc.sh
Outdated
| # i.e. /home/user/docs, /home/user/v4-periphery, /home/user/v4-core | ||
|
|
||
| # Copy v4-core | ||
| find ../v4-core/docs/src -type f -regex '.*\.sol/[^.]*\.[^.]*\.md' | while read file; do |
There was a problem hiding this comment.
so requires v4-core to be in a sibling repo and updated to latest manually? Would prefer if you handle dep management locally via submodule or something
scripts/v4-forge-doc.sh
Outdated
| # Replace relative path links within the file with full paths | ||
| sed -i 's|/src/\([^/]\+\)/\([^/]\+\)\.sol/\([^/]\+\)\.\([^/]\+\)\.md|contracts/v4/reference/periphery/\1/\2.md|g' "$new_file" | ||
|
|
||
| echo "Copied: $file -> $new_file" |
There was a problem hiding this comment.
consider deduping code into a helper fn? something like
process_component() {
local component="$1"
local src_dir="../v4-$component/docs/src"
local dest_dir="docs/contracts/v4/reference/$component"
find "$src_dir" -type f -regex '.*\.sol/[^.]*\.[^.]*\.md' | while read -r file; do
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
1. Runscript runs doc generation nowforge docin../v4-coreand../v4-periphery2. Run
./scripts/v4-forge-doc.shforge docNOTE:
forge doc will document internal functions too, and is entirely natspec driven