This repository was archived by the owner on Sep 5, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
This repository was archived by the owner on Sep 5, 2024. It is now read-only.
docs: header links are not working #11285
Copy link
Copy link
Closed
Labels
P2: requiredIssues that must be fixed.Issues that must be fixed.has: Pull RequestA PR has been created to address this issueA PR has been created to address this issueneeds: investigationThe cause of this issue is not well understood and needs to be investigated by the team or communityThe cause of this issue is not well understood and needs to be investigated by the team or communityresolution: fixedseverity: inconvenienttype: docs
Milestone
Description
Bug, enhancement request, or proposal:
Bug
Detailed Reproduction Steps:
- Open https://material.angularjs.org/latest/api/service/$mdDateLocaleProvider
- Find the
formatDate
header - Click on the header and it seems to update the URL properly to https://material.angularjs.org/latest/api/service/$mdDateLocaleProvider#mddatelocaleprovider-formatdate but it also seems to scroll that item off of the screen
- Hover over the header and it displays an invalid URL https://material.angularjs.org/latest/#mddatelocaleprovider-formatdate which makes it hard to send a link to a specific part of the docs to someone for reference
What is the expected behavior?
Linking to headers in the docs should work properly and navigate the user to the proper section of the docs.
What is the current behavior?
The header links often bring the user to the wrong part of the correct docs page or they just take the user to the AngularJS Material home page instead of the specific part of the docs that was intended.
What is the use-case or motivation for changing an existing behavior?
Meet user expectations when using the docs.
Which versions of AngularJS, Material, OS, and browsers are affected?
- AngularJS: 1.6.9
- AngularJS Material: 1.1.9
- OS: all
- Browsers: all
Is there anything else we should know? Stack Traces, Screenshots, etc.
This may be an issue with how we're generating the docs with the new dgeni. Either we may need to change something about how we're annotating them or dgeni may need to be fixed.
Metadata
Metadata
Assignees
Labels
P2: requiredIssues that must be fixed.Issues that must be fixed.has: Pull RequestA PR has been created to address this issueA PR has been created to address this issueneeds: investigationThe cause of this issue is not well understood and needs to be investigated by the team or communityThe cause of this issue is not well understood and needs to be investigated by the team or communityresolution: fixedseverity: inconvenienttype: docs