Functionality loss: Harder to find APIs with new docs.

[brucejo75]

I love the new look and feel of the docs and contents browsing. BUT...

I have lost a major functionality. The old docs had the entirety of the API in the sidebar. So I could search for an API by searching the sidebar. Then I could find the result in the sidebar in context with other APIs.

The new docs do not have a search and even if search was available it would be a loss in functionality because I would rather see the result in context with other APIs.

Come to think of it, that is a problem with the guide also. I cannot easily search the entire table of contents and I have wrestled with finding things in the guide as a consequence.

In the interim is there a link to the old docs available?

Request

Display the entire API in the sidebar like the old docs.
Display the entire TOC for the guide in the sidebar.

Bonus

Add sidebar search that jumps you to the location of the API in context with the rest of the API.
Limiting the list of APIs like underscore does is less desirable.

[lorensr]

Site search is in the works: #5

Display the entire API in the sidebar like the old docs.
Display the entire TOC for the guide in the sidebar.

@dominicnguyen thoughts on this change in the default docs? If not, could add to the one-page version (FR #8)

[domyen]

Thank you for the well thought out issue report!

re: viewing entire API
The use case of seeing the entirety of Meteor's API in one place makes sense. Perhaps a function/method reference page that displays all functions and links to their respective areas in the docs can satisfy the use case of getting a birds-eye view of the API.

re: search
This is at the top of our todo list. As you mentioned, it's not at the heart of your issue, but it may contribute to the lack of browse-ability.

similar issue: #31 (comment)

[brucejo75]

I really thing it should be similar to the old docs.

• At least 50% of the time my use of the docs is in search of something I do not know the name of. But I know what it should be similar to. I am concerned that search will deliver only what I ask for. Which at least 50% of the time I do not know what I need. It is about discovery.
• The format that you switched from is a prevalent form on the web for a good reason. And it worked quite well.

It seems like it could be possible to have the TOC open to show the entire 2nd level (e.g. APIs). Even though you are only displaying one section in the right?

Do you have a pointer to the old docs that could be used while this is being worked out? I almost find the new docs unusable. I have to count on google and right now google does not appear have that page well indexed. All searches send me to the top section (leftover from the old site maybe?)

Thanks

[lorensr]

Perhaps a function/method reference page that displays all functions and links to their respective areas in the docs can satisfy the use case of getting a birds-eye view of the API.

Or an "expand [all]" button/link in light grey either:

• below "Meteor API Docs" that applies to all
• to the right of "API" that works per-section

[brucejo75]

I think expand all would likely do the trick. I do not need to see the all the details at once (impossible anyway), but I think the TOC entries being fully expanded would resolve the core use case.

I am getting the feeling nobody wants to discuss making the old doc site available on another link?

[lorensr]

I am getting the feeling nobody wants to discuss making the old doc site available on another link?

😊 I just wasn't involved with deployment. I tagged the right person here: #31 (comment)

[lorensr]

@dominicnguyen thoughts on an expand link?