release notes position: fixed headers hide critical information
| Originator: | mayoff | ||
| Number: | rdar://32698546 | Date Originated: | 11-Jun-2017 12:54 AM |
| Status: | Open | Resolved: | |
| Product: | Documentation | Product Version: | Version 9.0 beta (9M136h) / 10.13 Beta (17A264c) |
| Classification: | Serious Bug | Reproducible: | Always |
Summary: Dear Documentationeros, The position: fixed headers in Release Notes documentation pages hides important information. Consider the AppKit Release Notes for macOS 10.13, found here: https://developer.apple.com/library/content/releasenotes/AppKit/RN-AppKit/index.html This page has a link titled “Layer-backed Views”. Since my app uses layer-backed views for some pretty important features, and since I started getting mysterious layer-related crashes when I tested my app on macOS 10.13 (see rdar://32698202), I was pretty interested in this section of the release notes. So I dutifully clicked on the link. I didn’t find anything relevant to my crashes. Fortunately, I attended WWDC17 and was able to talk to AppKit engineers who diagnosed my problem and explained the change in AppKit that caused my problems. I later discovered that this change *is* documented in the “Layer-backed Views” section of the release notes, in a paragraph titled “Stricter allocation of view-backing layers”! So why didn’t I see it? I didn’t it because it was covered by the position: fixed headers. Please see the attached video. Here’s what’s in the video: 1. I start at the top of the AppKit Release Notes for macOS 10.13 page. 2. I click the “Layer-backed Views” link. 3. The “Stricter allocation of view-backing layers” title and paragraph are *not* visible. I have no idea that I’m not seeing the critical information *to which I clicked a link*. 4. I use the Safari debug tools to hide the fixed headers. 5. The critical information *to which I clicked a link* is now visible. Please fix the documentation layout so that the target of a link actually becomes visible when I click the link. Thanks, Rob Steps to Reproduce: Expected Results: Actual Results: Version: Version 9.0 beta (9M136h) / 10.13 Beta (17A264c) Notes:
Comments
Please note: Reports posted here will not necessarily be seen by Apple. All problems should be submitted at bugreport.apple.com before they are posted here. Please only post information for Radars that you have filed yourself, and please do not include Apple confidential information in your posts. Thank you!
Apple Developer Relations September 14 2017, 11:31 PM
Thank you for filing this bug report! We are in the process of re-imagining our release note publishing process and pipeline, which will aim to address this and other issues. Unfortunately we will not be making changes to the current experience as part of this process, but this anchoring overlap is a known issue.
We are now closing this bug report.
If you have questions or comments about the resolution, please update your bug report with that information so we can respond.