Documentation Feedback #44
Labels
documentation
Improvements or additions to documentation
misc
Miscellaneous subjects such as project questions or troubleshooting
Hey! Sorry if this isn't the place for this but I thought I'd quickly share some feedback with you because you were asking. The google feedback form had too many required irrelevant questions for what I wanted to say and I didn't want to pollute your data with fake answers.
I tried to use this project for a 7 day game jam (currently on-going) so I do want to preface this by saying that I didn't give this project anywhere close to the proper time or thought it deserves (about 15-20 minutes total) and that I'm sure it's great but I can share my perspective as an outsider that saw this project and thought "oh I can make a quick settings menu? Great!" and tried to use it with no context.
Going through, installation and set up seemed good, there were no real issues. The troubleshooting page seemed pretty good and fixed an issue I had. My primary issue is that as far as I can tell, nowhere in the docs does it describe how to actually connect the settings page. My vague impression was that stuff done in the editor view was making some kind of settings type somewhere that I could edit or drop into my SceneTree and make it appear when a button is pressed. Perhaps I was supposed to drag components into my own settings scene? But if so then it's less clear why I was going through the process of using that editor view.
Either way, I just thought it might be helpful to share that as someone with 0 context on this project coming in and trying to make a quick and dirty menu in about 30 minutes or so that my impression was that I could make what I needed faster without this project. Primarily because the "Time To 'Hello World'" was too long and the path there was unclear. I think it could be invaluable to have a bit in the docs about what node I should add to my scene tree or what API call I should make to make the settings page appear or hit me over the head with an explicit "This plugin provides components to build your own settings page, here's a Hello World example". I did see that you had a demo project so perhaps that would have been sufficient for my needs but it seemed like too much work to get that set up when I was hoping to see screenshots/code snippets to get the smallest possible menu set up immediately.
The project seems really cool and I'd love to check it out again later when I have more to dedicate to figuring it out, and if quick and dirty game jam menus made by people with 0 context aren't the goal of this project then you can safely ignore this feedback.
The text was updated successfully, but these errors were encountered: