Appsilon / shiny.fluent

Microsoft's Fluent UI for Shiny apps
https://appsilon.github.io/shiny.fluent
276 stars 33 forks source link

Relative links in R documentation does not work in RStudio Help #187

Open PawanRamaMali opened 1 year ago

PawanRamaMali commented 1 year ago

Code example

Issue: The following links do not work in RStudio Help Tab:

  1. icon documentation
  2. icon documentation
  3. Quick Actions
  4. Search Results
  5. Lazy Loading
  6. Bulk Operations

Bug description

What happened: After clicking on links nothing happens. For example, the below link for icon documentation does not point to anywhere, whereas the official docs link works fine. image

Below links are affected:

  1. icon documentation
  2. icon documentation
  3. Quick Actions
  4. Search Results
  5. Lazy Loading
  6. Bulk Operations

Expected behavior

Expected behavior: After clicking on the links expected to view linked documents or web pages.

Comments

No response

kamilzyla commented 1 year ago

Thanks @PawanRamaMali for reporting the issue!

Our docs were generated by scraping the official Fluent UI docs; their structure is quite different from ours and many tweaks were needed to make it work. Still, some pages might be missing and links might be broken on occasion. In such situations you should be able to find the missing docs at the official site, e.g. Announced - Quick Actions.

PawanRamaMali commented 1 year ago

Hi @kamilzyla , I have created this PR to update these links.

kamilzyla commented 1 year ago

Thanks for the PR @PawanRamaMali! Unfortunately it's not a permanent solution for this issue. The R/documentation.R file is generated by the scripts in the scrape-docs directory; the next time we run them these changes will be lost. I'll reopen the issue so we don't forget about it in the future.