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.

Sign up for GitHub

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

Jump to bottom

Regression in docs search #10872

Closed
Blacksmoke16 opened this issue Jul 2, 2021 · 1 comment · Fixed by #10875
Closed

Regression in docs search #10872

Blacksmoke16 opened this issue Jul 2, 2021 · 1 comment · Fixed by #10875
Labels
kind:bug A bug in the code. Does not apply to documentation, specs, etc. kind:regression Something that used to correctly work but no longer works topic:tools:docs-generator
Milestone
1.1.0

Comments

@Blacksmoke16
Copy link
Member

Bug Report

  • Navigate to https://crystal-lang.org/api
  • Search for each_with_index (or any method really)
  • Click on one of the results
  • See that you taken to that method's definition
  • Now navigate to https://crystal-lang.org/api/master
  • Search for something else
  • Click on one of the results again
  • See that you get taken to that type's page, but the anchor tag is undefined and it doesn't take you to the method definition
@Blacksmoke16 Blacksmoke16 added the kind:bug A bug in the code. Does not apply to documentation, specs, etc. label Jul 2, 2021
@straight-shoota
Copy link
Member

This is caused by #10109 which removed the id property on features in the doc generator JSON output.

It seems this was just a duplicate of html_id, so we can use that instead in the search implementation.

@straight-shoota straight-shoota added this to the 1.1.0 milestone Jul 2, 2021
@straight-shoota straight-shoota mentioned this issue Jul 2, 2021
Merged
@straight-shoota straight-shoota added the kind:regression Something that used to correctly work but no longer works label Jul 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind:bug A bug in the code. Does not apply to documentation, specs, etc. kind:regression Something that used to correctly work but no longer works topic:tools:docs-generator
Projects
None yet
Milestone
1.1.0
Development

Successfully merging a pull request may close this issue.

Fix docs generator search use html_id straight-shoota/crystal
2 participants
@straight-shoota @Blacksmoke16