The Future of Creator Documentation - Docs Site Beta

The old documentation is now “out of date”, and the new and “improved” one is far from a stable, finished product. And light mode is still nonexistent.
Apparently Roblox doesn’t like listening to user feedback. Very disappointing.

4 Likes

Why is the search on the new and “improved” documentation site so bad? If you’re going to deprecate something good, at least make something better.

old

new

3 Likes

As much as i like the classic documentation, the new documentation has a more modern feel to it. I am excited to see how this will look when the end result is here.

Keep it up.

Edit:

I have managed to found a bug on the comparison of LUAU and C#,
the greater than (>), less than (<), the & and the vert (don’t know this one) symbols seem to be missing from the Operators section.

I provided an image to show the problem more visual:

image

Hi, So im not sure if If I’m the only person who finds this problem though,

However, for me, the new documentation is difficult to read, I mean that the style with which it was made does not make me identify the things I need quickly.

In short, maybe a white theme that reminds you a little of the old documentation would be better, there is certainly too much black that confuses you to find the information

Surely, such a documentation would slow down some developers a lot, if they also find this problem

And The old documentation, when searching for thing in my opinion was more precise and faster practically immediate, This new one, even if very fast, it takes that second longer, which is bothersome

5 Likes

I have to agree with others that the style of the new documentation is visually very different, which definitely affects its usability and readability.
The new style with its dark colors, new fonts, weaker font weights, etc. is not for everyone.

Suggestions:

  • Provide a dark/white mode toggle so that users can switch to their preference.
  • Or, better yet, provide different themes to skin the docs.
  • Provide text options for the font, font weight, line spacing, etc.
  • Ideally, one of the themes should replicate the style of the old documentation, so users can switch back to the old appearance.

Luckily with CSS it is very easy to create new appearances and allow the users to adjust between them.

2 Likes

The Learn and Articles section of the current Roblox Developer Hub are such valuable resources that I wanted to be sure that you have plans on bringing this content over to the new system.

That content is some of the best learning material Roblox has ever developed, and is an incredible resource for developers of all skill levels.

  • Tons of content and topics
  • Very well written
  • Easy to understand
  • Great use of multimedia
  • Beautifully styled

The Roblox team responsible for this documentation should be commended. So I just hope all this excellent content is retained or makes it to the new system.

1 Like

The reason why you can download DevForum as an app in the first place is because it’s based on an off-the-shelf forum system. It’s not made by Roblox.

1 Like

No, the code to download an app from the homescreen is within the HTML.

Hello!

Thanks for all your feedback so far, it’s been invaluable to the team. We’ve been hard at work on the new Docs Site, and you’ll now notice the following improvements:

  • Search improvements - you can now search for specific functions and properties.
  • Performance improvements - you should see dramatic loading time improvements on API reference.
  • UX improvements - readability is improved, particularly when navigating API reference.
  • Studio release logs - you can now get release logs on Docs Site.
  • New landing pages - the landing pages are more visually interesting, and also highlight recent documentation updates.
  • Content improvements - there continues to be more and more documentation here! All the latest is now on the Docs Site.

Please continue to give us feedback, it’s really helpful!

Thanks all

9 Likes

Does this mean the new Documentation is no longer in beta?

Can release notes be posted in parity with the Developer Hub here? I’d like to start linking to the Docs Site but it appears that the most recent release notes (543) are only on the Developer Hub right now.

1 Like

Are there plans to give individual members their own pages again?

Hello, i can said that Loading Issue Now It’s solved it’s working good.

In my opinion, there is still a lot of work left to make the documentation clear
Among this there is certainly:

  • Better organize the contents as they are written, the text is too compact unlike the other documentation, This makes it much less clear

  • Add a white theme other than black as much as I like to use the black theme on various sites, on this type of site the black theme only makes it more unreadable

I like documentation where I can find the information I need in a short time, not by reading the whole story of that specific part.

Hope in a Future Good Documentation!

1 Like

I really wish I could use this documentation.

I find the interface and organization quite pleasing personally. It’s not all over the place, you find everything about a class at the same place, you can just scroll around or do Ctrl+F to find out more about a class without having to open 20 tabs. However this has been pushed a little too early.

There’s a really important issue: a portion of the api is… nonexistent? You can look up BasePart’s property LocalTransparencyModifier. The search engine does know about it, however it leads to the BasePart page, but it is nowhere to be seen. I’ve found a number of those other anomalies under other instances.

Also, the On This Page scrolling isn’t very functional on my computer. I have to scroll at the very bottom of the page to see the last few items.

I understand you guys want us to adopt the new documentation but I believe we’re still a few steps away from that. Keep us updated!

3 Likes

To me personally, the new UI is disorientating, I can’t find clear borders between different methods/events and so on. When clicked it used to bring you on a complete separate page which had nothing but the needed API there, now it just skips you to the part where it describes it, with no clear borders between it and the next method, I absolutely hate that… Right now id prefer the old version much more over the new one

One interesting thing I noticed is that the fonts on a Mac do not appear as strong as the fonts on a PC. The Mac font weight appears much weaker than when viewed on a Windows computer. I tested on various browsers, so this appears to be due to the rendering differences between a Mac and PC.

GOD these new docs suck, bring back the old ones
reserveservercreate


the entirety of TeleportService:ReserveServer is relegated to a footnote in the TeleportService documentation. old docs had a page for nearly every property and function in the engine, while this crap can’t even use ctrl+f properly because every class in the engine is listed on the left hand side, and keeps broken html tags in code blocks

redirecting the old websites to these garbage new docs was a mistake

1 Like

Not sure what you mean, there’s so much content here that I need to scroll out my browser in order to take a screenshot of all of the information provided.

I think you only looked at the “Summary” tab of TeleportService. On the right side-bar, you can find Methods > ReserveServer to find a more detailed guide on every property. The Summary tab is for quickly searching up properties, events, and methods without clutter.

1 Like

damn nvm you right. i still hate it though

There’s one thing I don’t like about this new doc site, and it’s how it’s quite easy to scroll out of a specific API you were reading

In the older version, you search up ReserveServer and it doesn’t matter how far down you scroll down, the ONLY thing you were gonna read about is ReserveServer

1 Like