jasmine.github.io icon indicating copy to clipboard operation
jasmine.github.io copied to clipboard

Jump to method in docs

Open KyleW opened this issue 7 years ago • 1 comments

The new doc format is great, but since it's no longer a single long page, I can't use my browsers "find" to jump to the line I want.

It would be great to add some version of search to the docs. Or maybe just add a second level to the outline on the left side of the page.

KyleW avatar Jan 23 '18 22:01 KyleW

We definitely want to continue iterating on the docs for Jasmine. For now, the older, prose-style, docs are still available, but the plan is to convert them into API style, tutorials, and getting started type docs, removing the one format to rule them all.

We would be happy to review a pull request to update the jsdoc template to include all of the functions of the current section (or even expand/collapse for all sections).

Search is a bit harder since the docs are hosted as github pages, but I'd be happy to take a pull request for that as well, if someone wants to dig into how to implement that without changing the hosting of the docs.

slackersoft avatar Jan 31 '18 00:01 slackersoft

Closing since the search functionality meets this need pretty well in my experience, and we haven't heard anything new since 2018. Anyone who disagrees should feel free to open a new issue with specifics.

sgravrock avatar May 13 '24 01:05 sgravrock