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

External links in documentation are relative #2883

Open
benrr101 opened this issue Sep 23, 2024 · 0 comments
Open

External links in documentation are relative #2883

benrr101 opened this issue Sep 23, 2024 · 0 comments
Labels
Area\Documentation Issue that requires changes in public documentations/samples. ✨ Good first issue Issues that are simple enough for newcomers

Comments

@benrr101
Copy link
Contributor

Description: There are a lot of links in the XML documentation that point to web pages. I'm calling these "external links". However, the vast majority of them are links that are relative to the root of the documentation website (eg <see href="/dotnet/framework/data/adonet/asynchronous-programming">Asynchronous Programming</see>). In the context of the IDE, these links become meaningless since the IDE doesn't know where they should go. In my case, the IDE simply ignores them. This leaves a lot of documentation in the IDE that ends with For more information see .

Solution: Although this will warrant a small bit of research, I think if we just add the documentation website root to these links, we should solve the issue. This unfortunately adds a dependency on the root domain not changing, but we already depend on web links not changing, so this doesn't make it much worse.

@benrr101 benrr101 added the Area\Documentation Issue that requires changes in public documentations/samples. label Sep 23, 2024
@JRahnama JRahnama added the 🆕 Triage Needed For new issues, not triaged yet. label Sep 23, 2024
@cheenamalhotra cheenamalhotra added ✨ Good first issue Issues that are simple enough for newcomers and removed 🆕 Triage Needed For new issues, not triaged yet. labels Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area\Documentation Issue that requires changes in public documentations/samples. ✨ Good first issue Issues that are simple enough for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants