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

Anchor links in the generated HTML docs are brittle #3255

Closed
lukaszcz opened this issue Dec 20, 2024 · 0 comments · Fixed by #3299
Closed

Anchor links in the generated HTML docs are brittle #3255

lukaszcz opened this issue Dec 20, 2024 · 0 comments · Fixed by #3299
Assignees
Labels
backend:html documentation Improvements or additions to documentation enhancement New feature or request html
Milestone

Comments

@lukaszcz
Copy link
Collaborator

When I want to link to specific standard library functions in the documentation, I can use an anchor link such as https://anoma.github.io/juvix-stdlib/Stdlib.Data.Set.AVL.html#Stdlib.Data.Set.AVL:84.

This is very brittle -- depends on declaration order. The documentation links to stdlib will break every time stdlib is updated. It would be a bit less brittle if the links contained identifier names and were not sensitive to order.

@lukaszcz lukaszcz added enhancement New feature or request documentation Improvements or additions to documentation html pending-review backend:html labels Dec 20, 2024
@lukaszcz lukaszcz added this to the 0.6.10 milestone Dec 20, 2024
@janmasrovira janmasrovira self-assigned this Jan 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend:html documentation Improvements or additions to documentation enhancement New feature or request html
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants