Your Brand New Engine API Reference Documentation is Here

Hi creators,

Today, we’re excited to launch our new Engine API reference documentation that makes these pages much easier to navigate and scan.

A new Engine API reference overview page

The Overview page now shows an alphabetized list of all content, with tabs to filter for the type of content that you want (e.g., classes, data types, enums).

Individual reference docs that are easier to scan

We’ve also updated the look and feel of individual Engine API Reference docs (example), including a consolidated summary table at the top, better formatting for deprecated items, and improved spacing and readability.

Improved navigation

Finally, each page has a new top bar that sticks to the top of your view for easy access as well as a table of contents for quick navigation.

We hope that these changes make our new Engine API reference much easier to navigate and use! These quality of life updates matters :slightly_smiling_face:

Please share any feedback with us below. Thank you!

191 Likes

This topic was automatically opened after 10 minutes.

Thats a very good change to the old api reference! good job, roblos

9 Likes

Looks awesome, keep up the great work! Way better than before!

9 Likes

No notes on the main + class pages, that’s so much better 10/10

But searching doesn’t seem to have receive any changes, and that’s what most people are ultimately going to use to find pages

Notice how there’s just a box, and the type is defined below for essentially no reason when that could be communicated through the icon instead. The padding is also a bit too much

13 Likes

This is great! But it’d be awesome if you addressed the community on the very real possibility that AI verifciation will make it “easier” for predators to “navigate and scan” for children on your platform.

7 Likes

I LOVE the FEEDBACK option

12 Likes

This team who made the docs update unfortunately has little control over that. Although we could bring the conversation back to the original announcements and maybe if we reply enough times they will listen.

1 Like

A part of me doesn’t believe that it will be enough. The community has asked just about everywhere for days, the community has yet to see a response.

3 Likes

Our goal as a community is to get the most recent post to 4k replies, and if they don’t respond when we get to 4k replies then the community will officially declare chaos.

Well the company seems to already be ok with making the platform’s safety even worse, so we should just declare it now. They haven’t shown that they’re willing to address the bigged red flag of this update that jeoprodizes it’s entire point.

1 Like

I like the new layout, but the new class page is very slow and sometimes freezes if you click on too many pages.

Also, the page for MarketplaceService just doesn’t even load at all.

4 Likes

If developers truly care about keeping the platform alive then the message should be spread everywhere. All this update does in terms of preventing predators is giving countries more reasons to ban the platform.

1 Like

Thanks for spotting we’re fixing this now

1 Like

Are there any plans to improving searching next? It’s incredibly absurd that you have to know exactly the name of the page you want to go to and not make any typos in order for it to actually show in results, a singular letter difference should not result in completely irrelevant results being shown.

6 Likes

Yes because the people working on the documentation site have a lot of control over the safety issues.

Go send your feedback on the threads that are actually on the topic and stop replying with this to unrelated posts. (this is to everyone who’s doing this)


This rework is amazing, while the send feedback button is a welcome change, why was the API Reference made read only on the GitHub repo?

7 Likes

hi, i think the layout is cool, but the body paragraphs are harder to read than the old documentation. i think the blue words from the old API documentation was so much more suitable for readers than the underlined words of the current one.

4 Likes

The issue where the MarketplaceService page failed to load has been fixed . Thank you for reporting this!

2 Likes

All jokes aside this is the one update I’ve actually been looking forward to so thanks

1 Like

really good update, looks so good :ok_hand:

1 Like