-
Notifications
You must be signed in to change notification settings - Fork 7
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
Removed old Component references from the Getting Started guide. #108
base: develop
Are you sure you want to change the base?
Conversation
I know we wanted to remove old Component interface references as part of BladeRunnerJS/brjs#1383, but this makes the getting started guide more complicated. Getting started guides are meant to be straightforward. IMO either we need to simplify the interface or not use it at all in the getting started guide. |
I think it is important to keep in mind that we want to teach people the proper way to do things. I agree that it is more complicated than it was, but I think it still remains pretty clear. In my opinion, if we still consider this to be at a too high level for the tutorial, we should try to simplify it. I would not remove it completely from the guide, because I do think that it is a feature that would be used and needs to be documented properly. |
Yes, I fully agree with this. Although the fact it's slightly more complex is a negative, telling people the wrong way to do things and then having to re-educate them later is a far bigger negative. In addition to that, advertising deprecated APIs to make our products appear simpler than they actually are is dishonest. |
You're assuming everyone is going to be using these interfaces. CT users yes, but I can't see everyone that takes BRJS using them. BRJS as a toolkit provides the enforcement of feature separation and the bundling of assets, but as far as how you write your Blades it's up to the developer. Yes we should suggest how people should write apps and how the Component interface helps, but IMO this isn't something that should be used in the getting started guide. |
Actually, CT is currently using the old |
To summarise what we decided on: |
…ince, although these are useful to have in our templates as they indicate the presence of unused parameters, within the documentation they just make things seem more complicated than they actually are.
Fixes BladeRunnerJS/brjs#1383 by removing old Component references from the Getting Started guide.