-
Notifications
You must be signed in to change notification settings - Fork 13
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: Non-intuitive order of chapters #167
Comments
I am not sure about that. I think your order is intuitive, but the other one as well. Maybe I want to see the validation first, to decide, if I will use the component. So I am happy with both versions. |
Thanks for your opinion! I guess you can still decide which chapter to read first. But logically, at least how I understand it, the explanation of the concept of a component and how you apply it comes first before providing some evidence that it is valid when applied to real world data. |
I agree with @jnnr |
There is also a docs issue in oemof/oemof: oemof/oemof#67 |
order is fixed #169 |
See #171 for further tasks |
I suggest to change the order of the docs. In my view, it makes more sense to first explain the usage and then show the validation. This would be the proposed order:
Getting started
User's guide
Model validation
Theoretical considerations
Reference
It can be done quickly so it can be included in the upcoming release.
The text was updated successfully, but these errors were encountered: