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

"ISablierV2NFTDescriptor" hyperlink not working #46

Closed
PaulRBerg opened this issue Jul 7, 2023 · 5 comments
Closed

"ISablierV2NFTDescriptor" hyperlink not working #46

PaulRBerg opened this issue Jul 7, 2023 · 5 comments
Labels
effort: high Large or difficult task. priority: 3 Nice-to-have. Willing to ship without this. type: bug Something isn't working. work: complex Probe-sense-respond. The relationship between cause and effect can only be perceived in retrospect.

Comments

@PaulRBerg
Copy link
Member

PaulRBerg commented Jul 7, 2023

Problem

  1. Go here: https://docs.sablier.com/contracts/v2/reference/core/contract.SablierV2NFTDescriptor
  2. Click on ISablierV2NFTDescriptor
  3. "Page Not Found"

Cause

Running pnpm run build in production produces the following warnings:

[WARNING] Docs markdown link couldn't be resolved: (/docs/contracts/v2/reference/core/interfaces/interface.ISablierV2NFTDescriptor.md) in "/vercel/path0/docs/contracts/v2/reference/core/contract.SablierV2NFTDescriptor.md" for version current
--
17:41:44.685 | [WARNING] Docs markdown link couldn't be resolved: (/docs/contracts/v2/reference/core/interfaces/interface.ISablierV2NFTDescriptor.md) in "/vercel/path0/docs/contracts/v2/reference/core/contract.SablierV2NFTDescriptor.md" for version current
17:41:52.983 | [WARNING] Docs markdown link couldn't be resolved: (/docs/contracts/v2/reference/core/interfaces/interface.ISablierV2NFTDescriptor.md) in "/vercel/path0/docs/contracts/v2/reference/core/contract.SablierV2NFTDescriptor.md" for version current
17:41:52.983 | [WARNING] Docs markdown link couldn't be resolved: (/docs/contracts/v2/reference/core/interfaces/interface.ISablierV2NFTDescriptor.md) in "/vercel/path0/docs/contracts/v2/reference/core/contract.SablierV2NFTDescriptor.md" for version curren

See, for example, this Vercel deployment.

It is a strange bug because:

  1. I cannot reproduce it locally on my machine - running pnpm run build generates no warnings and the ISablierV2NFTDescriptor hyperlink works.
  2. I've looked at the URLs themselves multiple times, and I've run out of ideas about what could go wrong. Might this be a bug in Docusaurus?
  3. The hyperlinks in the other contracts, e.g. SablierV2LockupLinear, are working just fine! and they are analogous.

Help Wanted

Cc @razgraf you said that you've gotten the same warnings locally - would you mind taking a quick look at this issue?

However, if you cannot reproduce either, let's just mark this bug as "backlog" and move on.

Resources

Potentially related: the Docusaurus docs on Markdown links.

@razgraf
Copy link
Member

razgraf commented Jul 8, 2023

Was experiencing this in both pnpm build and pnpm start by the way! Sure, I'll try to figure out a fix, although I've already spent an hour searching through Stack and Github issues the other day (when I discovered the problem) and nothing came up 🤔 Will assign some more time to this after I finish my part on the content side.

@PaulRBerg
Copy link
Member Author

Thanks for checking - don't worry. In the grand scheme of things, this bug doesn't matter. Let's focus on our other launch priorities.

@PaulRBerg PaulRBerg added work: complex Probe-sense-respond. The relationship between cause and effect can only be perceived in retrospect. effort: high Large or difficult task. priority: 3 Nice-to-have. Willing to ship without this. type: bug Something isn't working. and removed bug labels Jan 1, 2024
@PaulRBerg PaulRBerg changed the title "ISablierV2NFTDescriptor" hyperlink not working on "pnpm run build" "ISablierV2NFTDescriptor" hyperlink not working Jan 1, 2024
@PaulRBerg
Copy link
Member Author

I think I have figured out what's going on - for some reason, the name of the interface contains a lowercase Nft instead of an uppercase NFT:

SCR-20240101-nhvp

PaulRBerg added a commit that referenced this issue Jan 1, 2024
PaulRBerg added a commit that referenced this issue Jan 1, 2024
@PaulRBerg
Copy link
Member Author

Re-opening because it turns out that the warning is appearing again:

#137 (comment)

@PaulRBerg PaulRBerg reopened this Apr 18, 2024
@PaulRBerg
Copy link
Member Author

Fixed via 8248049.

It was a capitalization issue again.

Cc @smol-ninja @andreivladbrg for when you will re-generate the docs for V2.2, keep this in mind

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort: high Large or difficult task. priority: 3 Nice-to-have. Willing to ship without this. type: bug Something isn't working. work: complex Probe-sense-respond. The relationship between cause and effect can only be perceived in retrospect.
Projects
None yet
Development

No branches or pull requests

2 participants