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

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

Open
PawanRamaMali opened this issue May 17, 2023 · 3 comments · Fixed by #190
Open

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

PawanRamaMali opened this issue May 17, 2023 · 3 comments · Fixed by #190
Assignees

Comments

@PawanRamaMali
Copy link
Contributor

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
Copy link
Collaborator

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
Copy link
Contributor Author

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

@kamilzyla
Copy link
Collaborator

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.

@kamilzyla kamilzyla reopened this Jun 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants