Struggling to find straightforward API docs for Model and Program (or any engine docs)

[micahscopes]

Actual Result

For the life of me I can't find the API specs for Model or other engine module exports

Expected Result

I want a straightforward directory of all the classes and their APIs

Reproduce Steps

I've been clicking around the documentation page. I clicked through every single item in the various "API" sections and used "control-F" to search for "Model".

I finally found it by using google. It's here but I had a hard time finding it in the menu.

One more thing, on my phone the docs page sometimes gets stuck with a full screen length of whitespace and I have to scroll down or refresh to see the docs. It's also hard to search and navigate from the phone. There's no way to click through, no clear sequence for API docs. Sometimes I like using the phone to browse documentation so I can get away from the computer.

To Do List

• Add label and assign to milestone
• Coding
• Test

Background

To Do List

• Add label and assign to milestone
• Coding
• Doc update
• Whats new update
• Test

[micahscopes]

Ooh okay I just found the engine docs here under "submodule reference":

From the point of view of a newcomer, this is pretty confusing because Model is used in a lot of the tutorial examples yet when I go clicking on the various "API" items in the docs it's nowhere to be found.

My mental model is pretty nebulous still but I think these "submodule reference" docs are what I'm expecting from the "API reference" sections. It's still not clear to me me how much overlap there is between them.

[ibgreen]

@micahscopes Thanks for your feedback!

My apologies, the docs are in an intermediate state right now as a result of the recent big effort on the new v9 API and WebGPU support. The structure needs another pass. I am hoping to get back to this soon.

And as you say, Model is really the central class in the luma.gl API and it should be very easy to find it.

Also noting that we do have a search function in the header and it does find the Model page.

[ibgreen]

One more thing, on my phone the docs page sometimes gets stuck with a full screen length of whitespace and I have to scroll down or refresh to see the docs. It's also hard to search and navigate from the phone. There's no way to click through, no clear sequence for API docs. Sometimes I like using the phone to browse documentation so I can get away from the computer.

Yes better mobile support would be nice. @mletic has been experimenting with moving the docs from gatsby to docusaurus which seemed to work really well on phones.

[micahscopes]

Also noting that we do have a search function in the header and it does find the Model page.

Oh wow I totally missed it 😅 🔍 🕵️