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: Non-intuitive order of chapters #167

Closed
jnnr opened this issue Sep 29, 2020 · 6 comments
Closed

Docs: Non-intuitive order of chapters #167

jnnr opened this issue Sep 29, 2020 · 6 comments
Assignees
Milestone

Comments

@jnnr
Copy link
Member

jnnr commented Sep 29, 2020

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.

@jnnr jnnr added this to the v0.0.4 milestone Sep 29, 2020
@FranziPl
Copy link
Member

FranziPl commented Sep 29, 2020

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.

@jnnr
Copy link
Member Author

jnnr commented Sep 29, 2020

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 lucky 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.

@c-moeller
Copy link
Member

I agree with @jnnr
I think the current order was not created on purpose.

@c-moeller
Copy link
Member

There is also a docs issue in oemof/oemof: oemof/oemof#67
I think we are not up-to-date with our Getting-started-section, but I think this is nothing we could solve within oemof-heat anymore.

@c-moeller
Copy link
Member

c-moeller commented Oct 1, 2020

order is fixed #169

@c-moeller
Copy link
Member

See #171 for further tasks

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

3 participants