ember-api-docs icon indicating copy to clipboard operation
ember-api-docs copied to clipboard

Implement a "scroll to TOC" for method/event documentation

Open locks opened this issue 7 years ago • 4 comments

Some classes have extensive documentation, and sometimes after clicking to a method of the class, you'd like to go back to the table of contents to see some other part of the documentation, but your scrollbar is so tiny that you feel disheartened—I'm looking at you https://emberjs.com/api/ember/2.18/classes/Component.

The idea, then, would to introduce some way to "scroll to top" when you're for example at https://emberjs.com/api/ember/2.18/classes/Component/properties/isDestroying?anchor=isDestroying.

locks avatar Jan 11 '18 00:01 locks

👋 is this still something we want to implement? Was looking for a place to start contributing :)

deanpapastrat avatar Feb 03 '19 21:02 deanpapastrat

👋 @deanpapastrat - Yes, absolutely! I think the main idea here is that we would like a solution that uses native dom apis instead of jQuery.

Feel free to ping me here or on Discord (same username) if you need help getting started ✨

kennethlarsen avatar Feb 06 '19 07:02 kennethlarsen

Awesome! Any design principles we have documented that we can reference? Or should I just make it up as I go

deanpapastrat avatar Feb 07 '19 04:02 deanpapastrat

@deanpapastrat So far there's https://ember-styleguide.netlify.com/ as a reference

kennethlarsen avatar Feb 08 '19 08:02 kennethlarsen