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

Allow linking to symbols inside source documentation #1

Open
yorickpeterse opened this issue Jun 27, 2024 · 0 comments
Open

Allow linking to symbols inside source documentation #1

yorickpeterse opened this issue Jun 27, 2024 · 0 comments
Labels

Comments

@yorickpeterse
Copy link
Contributor

Description

Documentation of one symbol may refer to another symbol, i.e like so:

`Int.until`

We should turn such references into actual links to the fully qualified symbol URL. As a starting point, this should probably only support fully qualified references, e.g. std.int.Int.until, such that we don't need to maintain a giant hash map of all possible symbols for every page. I'm not entirely sure yet how to best implement this.

Related work

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant