Functionality loss: Harder to find APIs with new docs. about docs HOT 7 CLOSED

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)

from docs.

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)

from docs.

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

from docs.

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

from docs.

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?

from docs.

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)

from docs.

@dominicnguyen thoughts on an expand link?

from docs.