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.

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

forge doc <> if a contract is imported the hyperlink to the contract html page is not right #6386

Closed
2 tasks done
nakul1010 opened this issue Nov 21, 2023 · 0 comments · Fixed by #6388
Closed
2 tasks done
Labels
T-bug Type: bug

Comments

@nakul1010
Copy link

nakul1010 commented Nov 21, 2023

Component

Forge

Have you ensured that all of these are up to date?

  • Foundry
  • Foundryup

What version of Foundry are you on?

No response

What command(s) is the bug in?

forge doc --out contracts_md --serve --port 400

Operating System

macOS (Intel)

Describe the bug

If the forge doc command is run without enabling the out flag the doc works as expected
Command: forge doc --serve --port 400

But if the --out flag is enabled the contracts where other contracts from the same code base are imported the doc fails to inherit
Command: forge doc --out contracts_md --serve --port 400

To Recreate the bug

  • Clone the following GitHub repo
  • Run: forge doc --out contracts_md --serve --port 400
  • Go to any page that inherits the contract from the same repo.

Example: In dummy relay if you click the IRelay it gives out 404. The hyperlink is invalid.
Screenshot 2023-11-21 at 6 56 43 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-bug Type: bug
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant