-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Declutter class members #1
Comments
I shuffled the layout around. Here's what it looks like with simulated documentation: The type is now the very first thing displayed. It's rendered similar to function parameters, which causes it stand out more, and gives all member types a more consistent look. Category is the the section the property appears under in the properties panel. Loading/saving has to do with serializing the property to the RBXL format. Sometimes the value is serialized under a different property, or not at all. In general, I prefer to include any information that is available, since it's often more convenient than scanning through an API dump. |
Awesome work! This is so much better. Quick note: Do we need to display what "read-only" and "replicated" means? I feel like it's pretty self-explanatory! Maybe a tooltip if you think it's necessary? (I don't) |
Not sure yet. After I get documentation in, I'll do a pass to see what kinds of information should go where. |
Just some insight after using the sight recently-I think that areas like this are too cluttered. Take all of this with a grain of salt because I'm not a web developer!
As for the history and metadata-I think it is nice to have, but it's way too prominent and I think it could be displayed more thoughtfully. I don't really care about history unless I'm looking for it. Maybe it could be expanded and collapsed (globally, perhaps?)
Overall, when I'm looking at API docs, the most important things are parameters, return types, and documentation (which you had noted is in the works).
Value type: bool
is kind of hidden in there!I would really suggest stealing some design cues from https://docs.rs/. Their documentation site for libraries is one of my favorite parts of their ecosystem because it's coherent and consistent. Obviously, this a little bit apples to oranges because Roblox doesn't version their API and a goal of your site is to display the history of everything that has ever been.
The text was updated successfully, but these errors were encountered: