Fix wrong absolute link in doc generated markdown #8600
Closed
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.
Motivation
#8576 This issue found a link problem in
forge doc
generated website. Some link uses the wrong absolute link like/contracts/foo
which is an invalid URL.Solution
There are two parts using the wrong absolute link
contracts/consensus/authority/
For the inheritance page, we changed how the inheritance contract is processed and stored the relevant path( like
docs/src/contracts/portals/IERC20Portal.sol/interface.IERC20Portal.md
). We assemble the final link in the as_doc where inheritance is processed. We concatenate the link (like/Users/glaze/developer/foundry/rollups-contracts/docs/docs/src/contracts/inputs/IInputBox.sol/interface.IInputBox.md
) and clean it up and output the correct link (likefile:///Users/glaze/developer/foundry/rollups-contracts/docs/book/contracts/portals/IPortal.sol/interface.IPortal.html
.)