search

sablier-labs / docs

Documentation and guides for Sablier
https://docs.sablier.com
GNU General Public License v3.0
15 stars 7 forks source link

"ISablierV2NFTDescriptor" hyperlink not working #46

Closed PaulRBerg closed 2 months ago

PaulRBerg commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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 commented 6 months ago

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 commented 3 months ago

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

https://github.com/sablier-labs/docs/pull/137#issuecomment-2061882541

PaulRBerg commented 2 months ago

Fixed via https://github.com/sablier-labs/docs/commit/82480490d0a0558e3f1b429370062eed15f122cd.

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