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

Fix links and right section missmatch #193

Open
andreivladbrg opened this issue Oct 28, 2024 · 5 comments
Open

Fix links and right section missmatch #193

andreivladbrg opened this issue Oct 28, 2024 · 5 comments
Labels
effort: medium Default level of effort. priority: 1 This is important. It should be dealt with shortly. type: bug Something isn't working. work: complicated Sense-analyze-respond. The relationship between cause and effect requires analysis or expertise.

Comments

@andreivladbrg
Copy link
Member

andreivladbrg commented Oct 28, 2024

If you go to either of these links:

  1. https://docs.sablier.com/concepts/protocol/stream-types#unlock-linear
  2. https://docs.sablier.com/concepts/protocol/stream-types#unlock-cliff

both will direct you to the Exponential or Cliff Exponential shape instead

Unlock Linear Unlock Cliff
Unlock Linear Shape Unlock Cliff Shape

The issue affects all links, as each one simply directs you to the shape above with some levels.
I’m not sure what causes this or how to fix it.

@smol-ninja smol-ninja added effort: medium Default level of effort. priority: 1 This is important. It should be dealt with shortly. type: bug Something isn't working. work: complicated Sense-analyze-respond. The relationship between cause and effect requires analysis or expertise. labels Oct 28, 2024
@PaulRBerg
Copy link
Member

Huh. Interesting.

It might be a bug in Docusaurus. Upgrading to the last version might fix this.

@smol-ninja
Copy link
Member

This issue is linked with the load time of the function plots. Since plots are generated after the page has been loaded, this leads to the page to reset itself, and move the view either up or down.

To fix this, what if we replace the dynamically generated plots with their .webp images? For example, if you visit https://docs.sablier.com/guides/lockup/etherscan#step-1-go-to-contract-page-1, you'll notice that images load very quickly, and you land on the expected section.

@andreivladbrg
Copy link
Member Author

This issue is linked with the load time of the function plot

nice finding

what if we replace the dynamically generated plots with their .webp images

it would fix this, but doing so would make it harder to make changes as we would need to (i) update the plot code (ii) take a screenshot of it and (iii) upload the new screenshot plot.

if there is no other fix to keep the current method, i guess we should go for images

@smol-ninja
Copy link
Member

it would fix this, but doing so would make it harder to make changes as we would need to (i) update the plot code (ii) take a screenshot of it and (iii) upload the new screenshot plot.

I agree but its a one time job per release. Also, we should still keep the plot code somewhere in the docs to reuse it but avoid publishing it directly on the stream shape page.

@PaulRBerg
Copy link
Member

in Docusaurus, it is possible to have unlisted documents.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort: medium Default level of effort. priority: 1 This is important. It should be dealt with shortly. type: bug Something isn't working. work: complicated Sense-analyze-respond. The relationship between cause and effect requires analysis or expertise.
Projects
None yet
Development

No branches or pull requests

3 participants