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 sample app documentation panel is not working #1740

Closed
Vijay-Nirmal opened this issue Jan 9, 2018 · 18 comments
Closed

Relative links in sample app documentation panel is not working #1740

Vijay-Nirmal opened this issue Jan 9, 2018 · 18 comments
Labels
controls 🎛️ feature 💡 help wanted Issues identified as good community contribution opportunities

Comments

@Vijay-Nirmal
Copy link
Contributor

Vijay-Nirmal commented Jan 9, 2018

I'm submitting a...

  • Bug report
  • Sample app request

Current behavior

Since we are using MarkdownTextBlock to display the documentation in sample app relative links will not work.

applicationframehost_2018-01-09_20-41-12

Expected behavior

Work properly with relative links.

@nmetulev nmetulev added feature 💡 controls 🎛️ help wanted Issues identified as good community contribution opportunities labels Jan 11, 2018
@nmetulev
Copy link
Contributor

This might be possible to get working with some of the improvements to MarkdownTextBlock, I'll take a look

@avknaidu
Copy link
Member

@nmetulev This should work with #1639

@Vijay-Nirmal
Copy link
Contributor Author

Vijay-Nirmal commented Jan 12, 2018

Can we create a DocFX Flavored Markdown for documentation panel in sample app because docs.microsoft.com uses DocFX.

@nmetulev Is it possible to change GitHub Flavored Markdown to DocFX Flavored Markdown in GitHub?

@nmetulev
Copy link
Contributor

nmetulev commented Jan 12, 2018

For the MarkdownTextBlock, it is possible, but not likely. It requires changes in the parser and renderer, it's a lot of work for something that would only minimally improve the sample app (and would create breaking changes for actual users of the control)

For GitHub, I don't believe it's possible to change

@Vijay-Nirmal
Copy link
Contributor Author

@nmetulev Agree

@avknaidu
Copy link
Member

This is already working. Should we close this?

image

@nmetulev
Copy link
Contributor

They are clickable now, but don't actually do anything.

@avknaidu
Copy link
Member

what are you trying to achieve here? when you click on AnimationSet link what should happen? Should it open the docs page on browser?

@Vijay-Nirmal
Copy link
Contributor Author

No, it should go to the corresponding page.

@avknaidu
Copy link
Member

But there is no Sample Page in Sample App for Animation Set. What should happen in this case? should it open on browser?

@Vijay-Nirmal
Copy link
Contributor Author

Vijay-Nirmal commented Apr 30, 2018

In 3.0, there will be Sample Page for everything. If the control/helper doesn't have sample then it will be doc only sample page. Any way we can navigate the user to the corresponding page.

@avknaidu
Copy link
Member

Yes. Using Deeplink. So if you want the users to go to AnimationSet docs from the link above, all you need to do is Fire LinkClicked Event on Documentation Markdown and Navigate frame to this URI

uwpct://Animations?sample=animationset

So your links will change to [Animation Set](uwpct://Animations?sample=animationset).

only thing I am not sure about is how does it impact docs.microsoft.com

@Vijay-Nirmal
Copy link
Contributor Author

How does it affect docs.microsoft.com? This is only for Sample App

@gbarcho
Copy link
Contributor

gbarcho commented Jun 28, 2018

Whats the status?

@Vijay-Nirmal
Copy link
Contributor Author

It will be done after #1755 PR merged

@lucaasrojas
Copy link
Contributor

lucaasrojas commented Aug 3, 2018

@Vijay-Nirmal The PR #1755 has been merged, can we close this issue?

@Vijay-Nirmal
Copy link
Contributor Author

@lucaasrojas No, we can't. This issue is not fixed (as for as I know) unless @WilliamABradley fixed it in #1755 (I didn't follow the PR since I was busy). It was supposed to be done by me after #1755 PR merge.

@nmetulev
Copy link
Contributor

nmetulev commented Aug 3, 2018

Links now show up as links but don't work as anchor links. That's something that should be done in the actual MarkdownTextBlock

@ghost ghost locked as resolved and limited conversation to collaborators Nov 26, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
controls 🎛️ feature 💡 help wanted Issues identified as good community contribution opportunities
Projects
None yet
Development

No branches or pull requests

7 participants