PlanarAlly
PlanarAlly copied to clipboard
Kruptein
Improve documentation
There appears to be a good framework set up for documentation to be created, it just needs to get fleshed out and added.
A lot of features have a shadow cast on them because there's no documentation available on how to use them. Improving documentation would greatly improve usability.
Expanding on this, linking to various document links to get started would be helpful for new users.
Something like a flash message appearing for first time users as they follow through the interface linking to various parts of the planarally.io docs would help tremendously to get the hang of things for first time users.
I absolutely agree, there is a ton of work still required in the documentation aspect and helping new users.
Would you be against something like a tutorial state and then flashing messages around the first session to help get the game of things?
There would probably be a DM tutorial and a user tutorial.
To expand on this, was thinking something like this and create a custom component for the flashed messaged.
The state would be an integer or something and flow through the UI on first join. This would mean the user model on the server would need to save the state too.
I would maybe settle for a LocalStorage approach to store progress and or completion of the 'tutorials'. What's your opinion on that approach?
I haven't properly looked at the component linked, but it seems to always flash up in a specific corner? I would like the popup dialogs to be located relevant to the content they're talking about. I remember some places that do this properly, I'll see if I can find some examples.
Local storage would then queue the tutorial per-device and not per-user then right? I wouldn't think this would be ideal.
The component linked allows custom positioning options, four defaults (the four corners) and then custom styling for absolute positioning too.
I'm able to import the module and have it function properly but I'm getting all sorts of linting errors with it.
Local storage is indeed not as ideal as I originally thought. Adding it to the database is fine, but instead of adding dedicated tutorial fields/models, I would opt for adding a general purpose 'settings'/'extras' kind of field that is just a json string in which tutorial progression can be stored. I suggest this, because I can otherwise foresee a lot of tiny changes to the db across time just for small tutorial adjustments, which I would like to avoid.
The popup is pretty big :D I would need to see a more concrete example to judge this. It would be cool if you could mimick the same 'style' where the next button is half out of the bottom.
I would also suggest to maybe figure out if you can make the general page slighly darker and just have the relevant element the popup is talking about having some focus?
Did you manage to resolve the type errors you showed above?
I haven't figured out the lint errors, some quick googling didn't resolve anything for me.
I smushed the screenshot for size sake, it's not nearly as big on a standard browser. I would imagine I could tweak it if needed too, that's just the default size.
I tried to do the flex button style but moving it beyond the border cut the button off, maybe there's some CSS magic I could do to fix this (I'm very bad at CSS :)).
I like your approach on the database and I'll see what I can do on that end.
I'm not sure if the current component would have the capability to darken the screen and set focus, it might have to be within another component.
I won't have the time to look at the lint errors myself soon I think because I leave for vacation tomorrow for a week.
Don't waste your time trying to get the border fine, I'll take a look at the CSS later :) Also no worries about the darken/focus thingy, that can be done at a later time if deemed necessary.
I'll focus my efforts on the model changes and the actual tutorial content.
I'll try and implement what I can with the idea in mind of highlighting select elements.
Enjoy your vacation! 😁
