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

Fallback to package project URL when failing to resolve help xref #2065

Open
glopesdev opened this issue Nov 29, 2024 · 0 comments
Open

Fallback to package project URL when failing to resolve help xref #2065

glopesdev opened this issue Nov 29, 2024 · 0 comments
Labels
proposal Request for a new feature
Milestone

Comments

@glopesdev
Copy link
Member

Most built-in package documentation is built on docfx which provides a xrefmap.yml file to resolve class UIDs to URLs. However, for simpler projects or projects under development it would be convenient to have as a fallback the specified package project URL of the package.

This would allow people using the package to open a developer specified URL where they might be able to learn more about the package even before a full docfx website is available.

This fallback could also be activated if there is a xrefmap.yml file but it is somehow outdated so that at least the documentation landing page is launched.

@glopesdev glopesdev added the proposal Request for a new feature label Nov 29, 2024
@glopesdev glopesdev added this to the 2.9 milestone Nov 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proposal Request for a new feature
Projects
None yet
Development

No branches or pull requests

1 participant