Skip to content
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

docs: Add clarification for what some of the prompts do/mean #95

Open
tobybaratta opened this issue Aug 6, 2023 · 1 comment
Open

Comments

@tobybaratta
Copy link
Member

The generator prompts you to answer some questions that I think are a bit unclear to answer to someone just setting up a new bundle. For example, "Is this a "single instance" graphic?" -- without any context, this is hard to understand what is meant by it. Does this mean the graphic is only in one scene in OBS? The graphic is only used in one way with a single replicant populating its data (ie: same graphic, different replicant of data is used in parallel)?

In addition, the question regarding React is a bit unclear - some folk (myself included) might want React for their Dashboard but not for Graphics. I think it might be a bit better to be a bit clearer on the prompt for what it's doing / where.

I think another spot that could be helpful for clarification would be "panel name" versus "panel title". I put "Dashboard" in for the first option, had that get changed to dashboard, and then saw the prompt for the second question have the suggestion / autofill of "Dashboard" and got a bit confused as to what was meant by the first question. IE: Is it auto filled off the prior answer or off of a standard for Dashboard panels?

@tobybaratta
Copy link
Member Author

Notes

  • Single instance graphics are graphics that make sure that the graphic is only open in one place (IE: only open in a single tab).
  • Panel "ID" and Panel Title? Fix: Ask for 'Panel Title' first, then pre-fill "Panel ID" value with the panel title value.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant